Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update description for tenantID annotation and fix errors #141

Merged
merged 1 commit into from
Aug 9, 2021
Merged

docs: update description for tenantID annotation and fix errors #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/book/src/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,13 +437,13 @@ kubectl describe pod quick-start
<details>
<summary>Output</summary>

You can verifiy the following injected properties in the output:
You can verify the following injected properties in the output:

| Environment variable | Description |
| ---------------------- | ----------------------------------------------------- |
| `AZURE_AUTHORITY_HOST` | The Azure Active Directory (AAD) endpoint. |
| `AZURE_CLIENT_ID` | The client ID of the identity. |
| `AZURE_TENANT_ID` | The tenant ID of the Azure account. |
| `AZURE_CLIENT_ID` | The client ID of the AAD application. |
| `AZURE_TENANT_ID` | The tenant ID of the registered AAD application. |
| `TOKEN_FILE_PATH` | The path of the projected service account token file. |

<br/>
Expand Down
4 changes: 2 additions & 2 deletions docs/book/src/topics/labels-and-annotations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ The following is a list of available labels and annotations that can be used to

| Annotation | Description | Default |
| ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `azure.pod.identity/client-id` | Represents the identity client ID to be used with the pod. | |
| `azure.pod.identity/tenant-id` | Represents the Azure tenant ID to be used with the pod. | `AZURE_TENANT_ID` environment variable extracted from [`aad-pi-webhook-config`][1] ConfigMap |
| `azure.pod.identity/client-id` | Represents the AAD application client ID to be used with the pod. | |
| `azure.pod.identity/tenant-id` | Represents the Azure tenant ID where the AAD application is registered. | `AZURE_TENANT_ID` environment variable extracted from [`aad-pi-webhook-config`][1] ConfigMap |
| `azure.pod.identity/service-account-token-expiration` | Represents the `expirationSeconds` field for the projected service account token. It is an optional field that the user might want to configure this to prevent any downtime caused by errors during service account token refresh. Kubernetes service account token expiry will not be correlated with AAD tokens. AAD tokens will expire in 24 hours after they are issued. | `86400` (minimum `3600`) |

## Pod
Expand Down