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.

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: add troubleshooting guide #226

Merged
merged 1 commit into from
Oct 21, 2021
Merged

docs: add troubleshooting guide #226

merged 1 commit into from
Oct 21, 2021

Conversation

aramase
Copy link
Member

@aramase aramase commented Oct 21, 2021

Signed-off-by: Anish Ramasekar anish.ramasekar@gmail.com

Reason for Change:

Requirements

  • squashed commits
  • included documentation
  • added unit tests and e2e tests (if applicable).

Issue Fixed:

ref #97

Please answer the following questions with yes/no:

Does this change contain code from or inspired by another project? If so, did you notify the maintainers and provide attribution?

  • yes
  • no

Notes for Reviewers:

@aramase aramase requested a review from chewong as a code owner October 21, 2021 17:48

## Ensure the service account is labelled with `azure.workload.identity/use=true`

`azure.workload.identity/use=true` label on the service account represents the service account is to be used for workload identity. If the service account is not labelled, the mutating admission webhook will not inject the required environment variables or volume mounts to the workload pod.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`azure.workload.identity/use=true` label on the service account represents the service account is to be used for workload identity. If the service account is not labelled, the mutating admission webhook will not inject the required environment variables or volume mounts to the workload pod.
`azure.workload.identity/use=true` label on the service account represents the service account is to be used for workload identity. If the service account is not labeled, the mutating admission webhook will not inject the required environment variables or volume mounts into the workload pod.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apparently labeled and labelled are both correct 😱 . I've updated it to labeled.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

American vs British 😛

docs/book/src/troubleshooting.md Outdated Show resolved Hide resolved
Signed-off-by: Anish Ramasekar <anish.ramasekar@gmail.com>
@aramase aramase requested a review from chewong October 21, 2021 18:42
@aramase aramase enabled auto-merge (squash) October 21, 2021 18:43
@aramase aramase merged commit 2fa732e into Azure:main Oct 21, 2021
@chewong chewong deleted the troubleshooting branch October 21, 2021 18:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants