Add missing steps #892

IwonaLanger · 2024-10-25T12:05:02Z

Description

Changes proposed in this pull request:

Add the missing steps in the instructions on creating Secrets.

github-actions · 2024-10-25T12:05:13Z

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

ralikio · 2024-10-25T12:08:36Z

docs/user/03-21-instance-level-mapping.md

@@ -1,21 +1,22 @@
-# Create a Service Instance with a Custom Secret
+# Instance-Level Mapping


What is the meaning of the title?

I've added the explanation you provided - thank you :)

ralikio · 2024-10-25T12:10:54Z

docs/user/03-21-instance-level-mapping.md


-* A subaccount in the SAP BTP cockpit
+To create a service instance with a custom Secret, you must use the **btpAccessCredentialsSecret** field in the `spec` of the service instance. In it, you pass the Secret from the `kyma-system` namespace to create your service instance. You can use different Secrets for different service instances.


"pass the Secret name"

This is not an instruction, so I'm not using an imperative. This section just explains what this process consists in.

ralikio · 2024-10-25T12:12:49Z

docs/user/03-22-namespace-based-mapping.md

-5. In the same working directory, generate the Secret by calling the `create-secret-file.sh` script with the **operator** option as the first parameter and **namespace-name-sap-btp-service-operator** Secret as the second parameter.
+1. In the SAP BTP cockpit, create an SAP Service Manager service instance with the `service-operator-access` plan.
+2. Create a service binding to the SAP Service Manager service instance you have created.
+1. Get the access credentials of the SAP Service Manager instance with the `service-operator-access` plan from its service binding. Copy them from the SAP BTP cockpit as a JSON.


It looks like numbering starts from the beginning here (1 instead of 3)

ralikio · 2024-10-25T12:15:14Z

docs/user/03-22-namespace-based-mapping.md


 To have service instances from one subaccount associated with one namespace, you must use a Secret dedicated to this namespace to create these service instances.

 ## Prerequisites

-* A subaccount in the SAP BTP cockpit
+* A subaccount in the SAP BTP cockpit.
+* kubectl configured for communicating with your Kyma instance.

 ## Procedure

 ### Create a Namespace-Based Secret


Can we merge the section with the Create Your Custom Secret section. It seems like both do the same but just use different namespaces.

It's not exactly the same, and the idea was to describe two complete processes separately.

ralikio · 2024-10-25T12:50:57Z

docs/user/03-21-instance-level-mapping.md

-1. [Create an SAP Service Manager service instance](03-30-management-of-service-instances-and-bindings.md#create-a-service-instance) with the `service-operator-access` plan.
-2. [Create a service binding](03-30-management-of-service-instances-and-bindings.md#create-a-service-binding) to the SAP Service Manager service instance you have created.
+1. In the SAP BTP cockpit, create an SAP Service Manager service instance with the `service-operator-access` plan.
+2. Create a service binding to the SAP Service Manager service instance you have created.
 3. Get the access credentials of the SAP Service Manager instance from its service binding. Copy them from the BTP cockpit as a JSON.
 4. Create the `creds.json` file in your working directory and save the credentials there.
 5. In the same working directory, generate the Secret by calling the `create-secret-file.sh` script with the **operator** option as the first parameter and **your-secret-name**  as the second parameter.


The warning in the point 5 seems to bee to soon in the file.

ralikio · 2024-10-25T12:51:47Z

docs/user/03-21-instance-level-mapping.md

-1. [Create an SAP Service Manager service instance](03-30-management-of-service-instances-and-bindings.md#create-a-service-instance) with the `service-operator-access` plan.
-2. [Create a service binding](03-30-management-of-service-instances-and-bindings.md#create-a-service-binding) to the SAP Service Manager service instance you have created.
+1. In the SAP BTP cockpit, create an SAP Service Manager service instance with the `service-operator-access` plan.
+2. Create a service binding to the SAP Service Manager service instance you have created.


Can we point to the guide on how to create a binding in the prerequisites?

ralikio · 2024-10-25T12:55:46Z

docs/user/03-21-instance-level-mapping.md

+    kubectl get secret -n kyma-system {YOUR_SECRET_NAME}
+    ```
+
+   You can see the status `Created`.


The actual output of the command is as follows:

NAME TYPE DATA AGE my-secret Opaque 5 2m20s

I'm removing point 7 as it's unnecessary.

docs/user/03-21-instance-level-mapping.md

NHingerl · 2024-10-29T11:16:31Z

docs/user/03-21-instance-level-mapping.md

    ```

-    You see the status `Created`.
+    You see the staus `Created` and the message that your service instance has been created successfully.


Suggested change

You see the staus `Created` and the message that your service instance has been created successfully.

You see the status `Created` and the message that your service instance has been created successfully.

IwonaLanger added 2 commits October 25, 2024 14:01

Add missing instructions

80ea9a9

Add the docs

81bdbba

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

IwonaLanger self-assigned this Oct 25, 2024

IwonaLanger requested a review from a team as a code owner October 25, 2024 12:05

kyma-gopher-bot enabled auto-merge (squash) October 25, 2024 12:05

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

ralikio reviewed Oct 25, 2024

View reviewed changes

docs/user/03-21-instance-level-mapping.md Outdated Show resolved Hide resolved

Fix broken links

b1e82df

kyma-bot added the cla: yes Indicates the PR's author has signed the CLA. label Oct 25, 2024

IwonaLanger added 2 commits October 28, 2024 11:44

Add the links to SM documentation

ab11672

Apply review suggestions

d5e7a04

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 Oct 29, 2024

Fix a broken link

30340fd

NHingerl reviewed Oct 29, 2024

View reviewed changes

Apply Nina's suggestion

055a4f9

NHingerl approved these changes Oct 29, 2024

View reviewed changes

kyma-gopher-bot merged commit 3ac6b4a into kyma-project:main Oct 29, 2024
6 checks passed

kyma-bot assigned NHingerl Oct 29, 2024

kyma-bot added the lgtm Looks good to me! label Oct 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add missing steps #892

Add missing steps #892

IwonaLanger commented Oct 25, 2024

github-actions bot commented Oct 25, 2024

ralikio Oct 25, 2024

IwonaLanger Oct 29, 2024

ralikio Oct 25, 2024

IwonaLanger Oct 25, 2024

ralikio Oct 25, 2024

ralikio Oct 25, 2024

IwonaLanger Oct 28, 2024

ralikio Oct 25, 2024

ralikio Oct 25, 2024

ralikio Oct 25, 2024

IwonaLanger Oct 25, 2024

NHingerl Oct 29, 2024

		@@ -1,21 +1,22 @@
		# Create a Service Instance with a Custom Secret
		# Instance-Level Mapping


		* A subaccount in the SAP BTP cockpit
		To create a service instance with a custom Secret, you must use the btpAccessCredentialsSecret field in the `spec` of the service instance. In it, you pass the Secret from the `kyma-system` namespace to create your service instance. You can use different Secrets for different service instances.

	You see the staus `Created` and the message that your service instance has been created successfully.
	You see the status `Created` and the message that your service instance has been created successfully.

Add missing steps #892

Add missing steps #892

Conversation

IwonaLanger commented Oct 25, 2024

github-actions bot commented Oct 25, 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