Add the doc on Secret customization #933
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
IwonaLanger
added
documentation
kyma-bot
added
do-not-merge/work-in-progress
|
Add one of following labels |
kyma-bot
added
the
size/M
kyma-bot
removed
the
do-not-merge/work-in-progress
NHingerl
reviewed
Dec 19, 2024
docs/user/03-11-customize_secret.md
Outdated
| @@ -0,0 +1,45 @@ | |||
| # Customize the Default Credentials and Access | |||
|
|
|||
| You can customize the `sap-btp-manager` Secret and manage your own SAP BTP Operator's default configuration. | |||
There was a problem hiding this comment.
Does this mean "manage the default configuration of your own SAP BTP Operator", or "manage your own default configuration of the SAP BTP Operator"?
I assume the 2nd option, anyway I'd suggest phrasing it in an unambiguous way,
docs/user/03-11-customize_secret.md
Outdated
| ## Context | ||
|
|
||
| When you create SAP BTP, Kyma runtime, the `sap-btp-manager` Secret is automatically created as the default Secret managing the SAP BTP Operator's resources. | ||
| Any changes to the Secret are reverted, and the previous settings are restored within up to 24 hours. |
There was a problem hiding this comment.
Because the word reconciliation comes up in line 11, I'd introduce it here:
Suggested change
| Any changes to the Secret are reverted, and the previous settings are restored within up to 24 hours. | |
| Because of Kyma's automatic reconciliation, any changes to the Secret are reverted, and the previous settings are restored within up to 24 hours. |
(maybe you can phrase it more elegantly :D)
docs/user/03-11-customize_secret.md
Outdated
| To customize the `sap-btp-manager` Secret and prevent your changes from being reverted, you must stop the Secret's reconciliation. | ||
| With the customized Secret, you can perform the following actions: | ||
|
|
||
| * Manage your own SAP BTP Operator's default configuration |
There was a problem hiding this comment.
like in line 3, I find this noun phrase ambiguous. Can you disentangle it a bit?
docs/user/03-11-customize_secret.md
Outdated
| With the customized Secret, you can perform the following actions: | ||
|
|
||
| * Manage your own SAP BTP Operator's default configuration | ||
| * Migrate the instances you created outside of the Kyma environment to your Kyma cluster |
There was a problem hiding this comment.
instances of what? Kyma instances? Application instances? Service instances?
docs/user/03-11-customize_secret.md
Outdated
|
|
||
| ## Result | ||
|
|
||
| Your customized `sap-btp-manager` Secret is now the default SAP BTP Operator's Secret. It generates the SAP BTP service operator's resources, as shown in the following diagram: |
There was a problem hiding this comment.
preposition instead of genitive makes it easier to understand for me
Suggested change
| Your customized `sap-btp-manager` Secret is now the default SAP BTP Operator's Secret. It generates the SAP BTP service operator's resources, as shown in the following diagram: | |
| Your customized `sap-btp-manager` Secret is now the default Secret of the SAP BTP Operator. It generates the SAP BTP service operator's resources, as shown in the following diagram: |
docs/user/03-11-customize_secret.md
Outdated
|
|
||
| With the customized default `sap-btp-manager` Secret, you can perform the following actions: | ||
|
|
||
| * Migrate your instances created, for example, in Gardener, to the Kyma environment. |
NHingerl
previously approved these changes
Dec 19, 2024
nataliasitko
approved these changes
Dec 20, 2024
IwonaLanger
added
the
do-not-merge/hold
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Changes proposed in this pull request:
sap-btp-managerSecret.Related issue(s)
See #901