Skip to content

Commit 53972a9

Browse files
committed
Add doc info on certPath for Service Principal with Certificate
1 parent 7ad2b68 commit 53972a9

File tree

3 files changed

+20
-2
lines changed

3 files changed

+20
-2
lines changed

api/v1beta1/azureclusteridentity_types.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ type AzureClusterIdentitySpec struct {
5959
// ClientSecret is a secret reference which should contain either a Service Principal password or certificate secret.
6060
// +optional
6161
ClientSecret corev1.SecretReference `json:"clientSecret,omitempty"`
62-
// certPath is the path where certicates exist. When set, it takes precedence over ClientSecret for types that uses certs like ServicePrincipalCertificate.
62+
// certPath is the path where certificates exist. When set, it takes precedence over ClientSecret for types that uses certs like ServicePrincipalCertificate.
6363
// +optional
6464
CertPath string `json:"certPath,omitempty"`
6565
// TenantID is the service principal primary tenant id.

config/crd/bases/infrastructure.cluster.x-k8s.io_azureclusteridentities.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ spec:
124124
x-kubernetes-map-type: atomic
125125
type: object
126126
certPath:
127-
description: certPath is the path where certicates exist. When set,
127+
description: certPath is the path where certificates exist. When set,
128128
it takes precedence over ClientSecret for types that uses certs
129129
like ServicePrincipalCertificate.
130130
type: string

docs/book/src/topics/identities.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,24 @@ data:
125125
password: PASSWORD
126126
```
127127

128+
Alternatively, the path to a certificate can be specified instead of the k8s secret:
129+
130+
```yaml
131+
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
132+
kind: AzureClusterIdentity
133+
metadata:
134+
name: example-identity
135+
namespace: default
136+
spec:
137+
type: ServicePrincipalCertificate
138+
tenantID: <azure-tenant-id>
139+
clientID: <client-id-of-SP-identity>
140+
certPath: <path-to-the-cert>
141+
allowedNamespaces:
142+
list:
143+
- <cluster-namespace>
144+
```
145+
128146
## User-Assigned Managed Identity
129147

130148
<aside class="note">

0 commit comments

Comments
 (0)