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: Update documentation to reflect change from 'tenantId' to 'tenantID' #1057

Merged
merged 3 commits into from Jan 20, 2023

Conversation

reetasingh
Copy link
Contributor

@reetasingh reetasingh commented Jan 11, 2023

Reason for Change:

tenantId param will be deprecated in favor of tenantID. update the documentation to reflect change from 'tenantId' to 'tenantID

Requirements

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

Issue Fixed:

fixes #1027

Does this change contain code from or inspired by another project?

  • Yes
  • No

If "Yes," did you notify that project's maintainers and provide attribution?

Special Notes for Reviewers:

@reetasingh reetasingh marked this pull request as draft January 11, 2023 07:07
reetasingh added a commit to reetasingh/secrets-store-csi-driver-provider-azure that referenced this pull request Jan 11, 2023
@reetasingh reetasingh marked this pull request as ready for review January 11, 2023 07:47
Copy link
Member

@aramase aramase left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @reetasingh!

There are few other places in the website directory this needs to be updated.

grep -rnw website/ -e 'tenantId'
website/content/en/configurations/custom-environments.md:58:If the target cloud's identity provider system is [AD FS][adfs] (instead of Azure AD), then the `tenantId` property in `SecretProviderClass` should be set to `"adfs"`.
website/content/en/configurations/custom-environments.md:65:  tenantId: "adfs"
website/content/en/configurations/identity-access-modes/pod-identity-mode.md:36:    tenantId: "tid"                    # the tenant ID of the KeyVault  
website/content/en/configurations/identity-access-modes/user-assigned-msi-mode.md:38:    tenantId: "tid"                 # the tenant ID of the KeyVault  
website/content/en/configurations/identity-access-modes/service-principal-mode.md:36:    tenantId: "tid"                 # the tenant ID of the KeyVault
website/content/en/configurations/identity-access-modes/workload-identity-mode.md:37:    tenantId: "tid"                    # the tenant ID of the KeyVault  
website/content/en/configurations/identity-access-modes/system-assigned-msi-mode.md:38:    tenantId: "tid"                 # the tenant ID of the KeyVault  
website/content/en/configurations/sync-multiple-versions.md:38:    tenantId: "tid"                              # the tenant ID of the KeyVault
website/content/en/configurations/ingress-tls.md:72:* Set the `tenantId` and `keyvaultName`
website/content/en/configurations/ingress-tls.md:105:    tenantId: $TENANT_ID                    # the tenant ID of the KeyVault
website/content/en/configurations/sync-with-k8s-secrets.md:44:    tenantId: "tid"                             # the tenant ID of the KeyVault
website/content/en/configurations/set-env-var.md:44:    tenantId: "tid"                             # the tenant ID of the KeyVault
website/content/en/demos/standard-walkthrough/_index.md:106:    tenantId: "${TENANT_ID}"
website/content/en/getting-started/usage/_index.md:62:      tenantId: "tid"                       # the tenant ID of the KeyVault
website/content/en/getting-started/usage/_index.md:85:  | tenantId               | yes      | tenant ID containing the Key Vault instance. Should be set to `"adfs"` for [Azure Stack Hub clouds](../../configurations/custom-environments) using the AD FS identity provider system  

@aramase aramase changed the title Update documentation to reflect change from 'tenantId' to 'tenantID' docs: Update documentation to reflect change from 'tenantId' to 'tenantID' Jan 12, 2023
@reetasingh
Copy link
Contributor Author

@aramase fixed it

@codecov-commenter
Copy link

Codecov Report

Merging #1057 (ce71772) into master (2ea9af6) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1057   +/-   ##
=======================================
  Coverage   59.16%   59.16%           
=======================================
  Files          10       10           
  Lines        1097     1097           
=======================================
  Hits          649      649           
  Misses        413      413           
  Partials       35       35           

Copy link
Member

@aramase aramase left a comment

Choose a reason for hiding this comment

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

Thank you for the PR @reetasingh 🎉

lgtm

@aramase
Copy link
Member

aramase commented Jan 20, 2023

/azp run pr-e2e

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

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.

Update documentation to reflect change from 'tenantId' to 'tenantID'
3 participants