Add the doc on Secret customization #933

IwonaLanger · 2024-12-19T07:31:42Z

Description

Changes proposed in this pull request:

Add the document on how to customize the sap-btp-manager Secret
Update 03-10-preconfigured-secret.md
Adjust 03-70-delete-bindings-and-instances.md

Related issue(s)

github-actions · 2024-12-19T07:31:54Z

Add one of following labels

- kind/feature -> Use it when you want to submit a new feature

- kind/enhancement -> Use it when you modify or improve an existing feature

- kind/bug -> Use it when you fix a bug

docs/user/03-10-preconfigured-secret.md

docs/user/03-11-customize_secret.md

…r/btp-manager into add_customization_doc

docs/user/03-11-customize_secret.md

ralikio · 2025-01-24T12:48:14Z

docs/user/03-11-customize_secret.md

+
+Your customized `sap-btp-manager` Secret is now the default Secret of the SAP BTP Operator module. It generates the SAP BTP service operator's resources, as shown in the following diagram:
+
+![Customized module credentials](../assets/module_credentials_customized.drawio.svg)


Could we revert the direction of arrows between sap-btp-service-operator and sap-btp-manager secrets? Now it looks like sap-btp-manager points to values set in sap-btp-service-operator.

I think that is correct as "It generates the SAP BTP service operator's resources."

Values from sap-btp-manager are the source during reconciliation and sap-btp-service-operator is the target.

ralikio · 2025-01-24T12:58:33Z

docs/user/03-10-preconfigured-secret.md


 The following parameters manage cluster access:

 | Parameter                     | Description                                                                                   |
 |-------------------------------|-----------------------------------------------------------------------------------------------|
 | **CLUSTER_ID**                | Generated when Kyma runtime is created.                                                       |
-| **MANAGEMENT_NAMESPACE**      | Always set to `kyma-system`.                                                |
+| **MANAGEMENT_NAMESPACE**      | By default, set to `kyma-system`.                                                |


I am not sure that this config does and I cannot find it in out documentation. Maybe we could clarify it at least as a followup?

I'm not sure what to clarify here. Can you please clarify? This section is based on this source and modified according to PK's input.

More info has been added.

ralikio · 2025-01-24T13:05:32Z

docs/user/03-11-customize_secret.md

+* Label the Secret with `kyma-project.io/skip-reconciliation: 'true'`.
+* Provide the following credentials from your SAP Service Manager instance: **clientid**, **clientsecret**, **sm_url**, and **tokenurl**.
+* Optionally, provide your **cluster_id**. Otherwise, it is generated automatically.
+* Optionally, add the **credentials_namespace** parameter and provide the name of your custom namespace for Secrets with credentials to communicate with the SAP Service Manager.  


After reading this sentence I understood that the custom namespace should already contain credentials to use. Is that correct understanding? If not, could you change to something like "...the name of your custom namespace where sap-btp-operator-service Secret will be generated."?

That's correct, we assume the namespace already exists and it could contain anything user wants there. sap-btp-service-operator Secret also exists at this point, we just move it to the other namespace selected by user, it should remain the default Secret for communication with SAP Service Manager.

This is a rule. Using "will" is against the content guidelines.

So the credentials_namespace is the namespace where to move the secret to or from? In my previous, comment by "custom namespace" I meant credentials_namespace.

The credentials_namespace is the namespace for secrets, it does not concern only the sap-btp-service-operator secret. The sentence ...the name of your custom namespace where sap-btp-operator-service Secret will be generated." does not hold the true meaning of the namespace. User can create sap-btp-manager secret with the setting already provided and there won't be any movement of the secrets.

PK85 · 2025-01-24T13:06:22Z

docs/user/03-10-preconfigured-secret.md


 The following parameters manage cluster access:

 | Parameter                     | Description                                                                                   |
 |-------------------------------|-----------------------------------------------------------------------------------------------|
 | **CLUSTER_ID**                | Generated when Kyma runtime is created.                                                       |
-| **MANAGEMENT_NAMESPACE**      | Always set to `kyma-system`.                                                |
+| **MANAGEMENT_NAMESPACE**      | By default, set to `kyma-system`.                                                |
 | **ALLOW_CLUSTER_ACCESS**      | You can use every namespace for your operations. The parameter is always set to `true`.<br>If you change it to `false`, the setting is automatically reverted. |


@IwonaLanger please add here RELEASE_NAMESPACE too. Value: "By default, set to kyma-system."

docs/user/03-11-customize_secret.md

…r/btp-manager into add_customization_doc

NHingerl

just minor suggestions

docs/user/03-10-preconfigured-secret.md

docs/user/03-11-customize_secret.md

docs/user/03-70-delete-bindings-and-instances.md

NHingerl · 2025-01-27T13:26:09Z

docs/user/03-70-delete-bindings-and-instances.md

+You can't delete your Kyma cluster if any non-deleted service instances in it use the credentials from the SAP Service Manager resources created automatically, as described in [Preconfigured Credentials and Access](03-10-preconfigured-secret.md#credentials). In this case, the existing service instances block the cluster's deletion. Delete your service instances and bindings in Kyma dashboard before you attempt to delete the cluster from the SAP BTP cockpit.
+
+You can delete your Kyma cluster even if your service instances still exist, provided they all use credentials of SAP Service Manager service instances other than the one created automatically, as described in [Preconfigured Credentials and Access](03-10-preconfigured-secret.md#credentials). In this case, the non-deleted service instances do not block the cluster's deletion. 


Suggested change

You can delete your Kyma cluster even if your service instances still exist, provided they all use credentials of SAP Service Manager service instances other than the one created automatically, as described in [Preconfigured Credentials and Access](03-10-preconfigured-secret.md#credentials). In this case, the non-deleted service instances do not block the cluster's deletion.

However, if the service instances use credentials of SAP Service Manager service instances other than the one created automatically, you can delete your Kyma cluster even if your service instances still exist (see [Preconfigured Credentials and Access](03-10-preconfigured-secret.md#credentials)). In this case, the non-deleted service instances do not block the cluster's deletion.

Skipping "all" and moving the link changes the message.

docs/user/03-70-delete-bindings-and-instances.md

docs/user/03-10-preconfigured-secret.md

NHingerl

It might look nicer if the three boxes had the same size:

Sorry I didn't notice earlier :(

docs/user/03-10-preconfigured-secret.md

docs/user/03-11-customize_secret.md

Add the doc on Secret customization

82397f8

IwonaLanger added documentation Improvements or additions to documentation area/documentation Issues or PRs related to documentation kind/enhancement Categorizes issue or PR as related to modifying or improving an existing feature labels Dec 19, 2024

IwonaLanger self-assigned this Dec 19, 2024

kyma-bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cla: yes Indicates the PR's author has signed the CLA. labels Dec 19, 2024

kyma-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Dec 19, 2024

IwonaLanger added 3 commits December 19, 2024 08:34

Add the diagram

30add18

SAP BTP kubectl plugin no longer supported

516c8c0

Merge branch 'main' into add_customization_doc

f86b38c

jaroslaw-pieszka reviewed Dec 19, 2024

View reviewed changes

docs/user/03-10-preconfigured-secret.md Outdated Show resolved Hide resolved

jaroslaw-pieszka reviewed Dec 19, 2024

View reviewed changes

docs/user/03-11-customize_secret.md Outdated Show resolved Hide resolved

IwonaLanger added 3 commits December 19, 2024 10:25

Apply Jarek's suggestions

ddcd706

Merge branch 'add_customization_doc' of https://github.com/IwonaLange…

6279ae4

…r/btp-manager into add_customization_doc

Apply PK's suggestions

f7e7235

IwonaLanger marked this pull request as ready for review December 19, 2024 12:50

IwonaLanger requested review from a team as code owners December 19, 2024 12:50

kyma-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 19, 2024

kyma-gopher-bot enabled auto-merge (squash) December 19, 2024 12:50

Minor fixes

2053362

NHingerl reviewed Dec 19, 2024

View reviewed changes

Apply Nina's suggestions

646f1b8

NHingerl previously approved these changes Dec 19, 2024

View reviewed changes

kyma-bot assigned NHingerl Dec 19, 2024

kyma-bot added the lgtm Looks good to me! label Dec 19, 2024

PK's requested changes

c431ca3

IwonaLanger dismissed NHingerl’s stale review via c431ca3 December 20, 2024 11:36

Fix the diagram

bee378b

IwonaLanger removed the request for review from szwedm January 24, 2025 11:31

ralikio reviewed Jan 24, 2025

View reviewed changes

docs/user/03-11-customize_secret.md Outdated Show resolved Hide resolved

ralikio reviewed Jan 24, 2025

View reviewed changes

PK85 reviewed Jan 24, 2025

View reviewed changes

jaroslaw-pieszka reviewed Jan 24, 2025

View reviewed changes

docs/user/03-11-customize_secret.md Outdated Show resolved Hide resolved

IwonaLanger and others added 3 commits January 24, 2025 14:57

Apply review suggestions

65570ec

Add more info about MANAGEMENT_NAMESPACE and RELEASE_NAMESPACE

b4f79dc

Describe BTP Manager behavior on credentials_namespace param change

f529f8d

szwedm force-pushed the add_customization_doc branch from 65570ec to f529f8d Compare January 24, 2025 15:15

IwonaLanger added 2 commits January 27, 2025 08:06

Merge branch 'add_customization_doc' of https://github.com/IwonaLange…

d2f2b65

…r/btp-manager into add_customization_doc

Adjust deleting instructions

c49f5c9

kyma-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 27, 2025

IwonaLanger added 2 commits January 27, 2025 12:46

Formatting fix

8ba04fe

More specific phrasing

cc313e2

NHingerl reviewed Jan 27, 2025

View reviewed changes

Apply review suggestions

477544a

NHingerl reviewed Jan 27, 2025

View reviewed changes

docs/user/03-70-delete-bindings-and-instances.md Outdated Show resolved Hide resolved

NHingerl reviewed Jan 27, 2025

View reviewed changes

docs/user/03-10-preconfigured-secret.md Show resolved Hide resolved

NHingerl reviewed Jan 27, 2025

View reviewed changes

docs/user/03-10-preconfigured-secret.md Show resolved Hide resolved

szwedm self-assigned this Jan 28, 2025

Move cluster deletion details to another doc

4169d11

NHingerl reviewed Jan 30, 2025

View reviewed changes

docs/user/03-10-preconfigured-secret.md Outdated Show resolved Hide resolved

docs/user/03-11-customize_secret.md Show resolved Hide resolved

Apply review suggestions

b3d5a24

NHingerl approved these changes Jan 30, 2025

View reviewed changes

kyma-bot assigned NHingerl Jan 30, 2025

kyma-bot added the lgtm Looks good to me! label Jan 30, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add the doc on Secret customization #933

Add the doc on Secret customization #933

IwonaLanger commented Dec 19, 2024 •

edited

Loading

github-actions bot commented Dec 19, 2024

ralikio Jan 24, 2025

IwonaLanger Jan 24, 2025

jaroslaw-pieszka Jan 24, 2025

ralikio Jan 24, 2025

IwonaLanger Jan 24, 2025

IwonaLanger Jan 27, 2025

ralikio Jan 24, 2025

szwedm Jan 24, 2025

IwonaLanger Jan 24, 2025

ralikio Jan 24, 2025

szwedm Jan 24, 2025

PK85 Jan 24, 2025

NHingerl left a comment

NHingerl Jan 27, 2025

IwonaLanger Jan 27, 2025

IwonaLanger Jan 28, 2025

NHingerl left a comment


		Your customized `sap-btp-manager` Secret is now the default Secret of the SAP BTP Operator module. It generates the SAP BTP service operator's resources, as shown in the following diagram:

		![Customized module credentials](../assets/module_credentials_customized.drawio.svg)

		You can't delete your Kyma cluster if any non-deleted service instances in it use the credentials from the SAP Service Manager resources created automatically, as described in [Preconfigured Credentials and Access](03-10-preconfigured-secret.md#credentials). In this case, the existing service instances block the cluster's deletion. Delete your service instances and bindings in Kyma dashboard before you attempt to delete the cluster from the SAP BTP cockpit.

		You can delete your Kyma cluster even if your service instances still exist, provided they all use credentials of SAP Service Manager service instances other than the one created automatically, as described in [Preconfigured Credentials and Access](03-10-preconfigured-secret.md#credentials). In this case, the non-deleted service instances do not block the cluster's deletion.

	You can delete your Kyma cluster even if your service instances still exist, provided they all use credentials of SAP Service Manager service instances other than the one created automatically, as described in [Preconfigured Credentials and Access](03-10-preconfigured-secret.md#credentials). In this case, the non-deleted service instances do not block the cluster's deletion.
	However, if the service instances use credentials of SAP Service Manager service instances other than the one created automatically, you can delete your Kyma cluster even if your service instances still exist (see [Preconfigured Credentials and Access](03-10-preconfigured-secret.md#credentials)). In this case, the non-deleted service instances do not block the cluster's deletion.

Add the doc on Secret customization #933

Are you sure you want to change the base?

Add the doc on Secret customization #933

Conversation

IwonaLanger commented Dec 19, 2024 • edited Loading

github-actions bot commented Dec 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NHingerl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NHingerl left a comment

Choose a reason for hiding this comment

IwonaLanger commented Dec 19, 2024 •

edited

Loading