Skip to content

Commit 62a364d

Browse files
committed
Update from SAP DITA CMS (squashed):
commit 9794cb80669dff4a83e55989688b269105617ac0 Author: REDACTED Date: Wed Nov 13 10:23:21 2024 +0000 Update from SAP DITA CMS 2024-11-13 10:23:21 Project: dita-all/aqd1698149070184 Project map: beff08357c9a409b9e181982b3174d9a.ditamap Output: loio8ba818df56c848cb808b6d698ed01afe Language: en-US Builddable map: 104367d9dc224fe7a6c407e498877d64.ditamap commit 85cb8ecc37abe748c65dcd5e87e6bef88a97486a Author: REDACTED Date: Wed Nov 6 12:36:44 2024 +0000 Update from SAP DITA CMS 2024-11-06 12:36:44 Project: dita-all/aqd1698149070184 Project map: beff08357c9a409b9e181982b3174d9a.ditamap Output: loio8ba818df56c848cb808b6d698ed01afe Language: en-US Builddable map: 104367d9dc224fe7a6c407e498877d64.ditamap commit 504aa1d4d158e413f7664d60842620bf9a0df80f Author: REDACTED Date: Wed Nov 6 10:37:14 2024 +0000 Update from SAP DITA CMS 2024-11-06 10:37:14 Project: dita-all/aqd1698149070184 Project map: beff08357c9a409b9e181982b3174d9a.ditamap Output: loio8ba818df56c848cb808b6d698ed01afe Language: en-US ################################################## [Remaining squash message was removed before commit...]
1 parent 4186264 commit 62a364d

File tree

45 files changed

+837
-361
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+837
-361
lines changed

docs/admin-and-ops/bind-a-service-instance-0aead0c.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Bind a SAP Credential Store instance to your Cloud Foundry or Kyma application t
1010

1111
## Prerequisites
1212

13-
- You've created a service instance for SAP Credential Store. See: [Create a Service Instance](create-a-service-instance-dc5f087.md)
13+
- You've [created a service instance](create-a-service-instance-dc5f087.md) for SAP Credential Store.
1414

1515
- You've downloaded and installed the [Cloud Foundry command line interface](https://help.sap.com/products/BTP/65de2977205c403bbc107264b8eccf4b/4ef907afb1254e8286882a2bdef0edf4.html) \(cf CLI\).
1616

@@ -127,7 +127,7 @@ To find them in the cockpit, open *Environment Variables* and see:
127127
**Related Information**
128128
129129
130-
[Enable, Disable and Delete Service Bindings](enable-disable-and-delete-service-bindings-eb06422.md "Manage the bindings related to your SAP Credential Store service instance.")
130+
[Enable, Disable and Delete a Service Binding](enable-disable-and-delete-a-service-binding-eb06422.md "Manage the service bindings related to your SAP Credential Store service instances.")
131131
132132
[Access Control Lists](../security/access-control-lists-81a9cb6.md "In SAP Credential Store, access control lists define the access (assignment) of a service binding to particular groups of credentials on a subaccount or namespace level.")
133133

docs/admin-and-ops/create-a-service-instance-dc5f087.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,21 @@ You can create a service instance in two ways:
3737
3838
## Procedure
3939
40-
1. From the *Credential Store* tile, choose *Create*.
40+
1. Select the *Credential Store* tile and then choose *Create*.
4141
42-
2. Select a service plan \(**free**, **standard**, or **proxy**\).
42+
> ### Tip:
43+
> Alternatively, you can go to your space, navigate to *Services* \> *Service Marketplace*, and from the upper right corner choose *Create* \> *Service Instance*.
4344
44-
3. Enter a name for your service instance. For example: **mycredstore**
45+
2. Select a service plan \(*trial*, *free*, *standard*, or *proxy*\).
46+
47+
> ### Note:
48+
> Use the *proxy* plan only if you want to share your service instance with other subaccounts or spaces. See: [Create a Proxy Service Instance](https://help.sap.com/docs/credential-store/sap-credential-store/sharing-service-instances-cockpit?version=Cloud#create-a-proxy-service-instance)
49+
50+
3. Enter a name for your service instance.
4551
4652
4. Choose *Next* to set additional parameters, or *Create* to directly create your service instance.
4753
48-
5. To see your newly created instance, choose ![](images/Actions_62e6f79.png) \(*Actions*\) and then *Instances and Subscriptions*.
54+
5. You can see your newly created instance in your space, by navigating to *Services* \> *Instances*.
4955
5056
6. As a next step, you can bind your service instance to an application. See: [Bind a Service Instance](bind-a-service-instance-0aead0c.md)
5157

docs/admin-and-ops/create-and-delete-a-namespace-401b20c.md

Lines changed: 29 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<!-- loio401b20ca5b4c46d28e97563d9577b6d6 -->
22

3+
<link rel="stylesheet" type="text/css" href="../css/sap-icons.css"/>
4+
35
# Create and Delete a Namespace
46

57
To create and use any kind of credentials, you first need to create a namespace.
@@ -12,7 +14,7 @@ To create and use any kind of credentials, you first need to create a namespace.
1214

1315
- You've enabled SAP Credential Store for your subaccount on your Cloud Foundry or Kyma space. See: [Initial Setup](../initial-setup-d5f1ce7.md)
1416

15-
- You've created a service instance for SAP Credential Store. See: [Create a Service Instance](create-a-service-instance-dc5f087.md)
17+
- You've [created a service instance](create-a-service-instance-dc5f087.md) for SAP Credential Store.
1618

1719

1820

@@ -25,33 +27,44 @@ Follow the steps below to create one or multiple namespaces for your service ins
2527

2628
## Procedure
2729

28-
1. From the left-side navigation menu, choose *Services* \> *Instances*.
30+
1. In the SAP BTP cockpit, navigate to your subaccount and space.
31+
32+
2. From the left-side navigation menu, choose *Services* \> *Instances*.
2933

30-
2. Select a *Credential Store* instance.
34+
3. Select a *Credential Store* instance.
3135

32-
3. From the left-side navigation menu, choose *Credential Store*.
36+
4. From the left-side navigation menu, choose <span style="color:#ffffff;"><span class="SAP-icons-V5"></span></span> \(Credential Store\).
3337

34-
4. In the default table are listed all the namespaces you have already created, if any. To create a new one, choose *Create Namespace*.
38+
5. In the default table are listed all the namespaces you have already created, if any. To create a new one, choose *Create Namespace*.
3539

36-
5. As a first step, you need to create a credential within the new namespace. Thus, choose a credential type \(**Password**, **Key**, or **Keyring**\) and then *Next*.
40+
6. As a first step, you need to create a credential within the new namespace. Choose a credential type \(**Password**, **Key**, or **Keyring**\) and then *Next*.
3741

38-
6. Enter a name for your new namespace.
42+
7. Enter a name for your new namespace.
3943

40-
7. Enter a credential name.
44+
8. Enter a name for your first credential.
4145

42-
8. You can manually enter a credential value or let the wizard generate one for you.
46+
9. You can manually enter a credential value or let the wizard generate one for you.
4347

4448
If you choose to generate, proceed as follows, depending on the credential type:
4549

4650
- *Password* – to generate a password, you need to set its length, which must be at least 8 and no longer than 4096 symbols. Also, when the creation is done, the generated password **hash** \(not its real value\) will be displayed for you. Copy the provided string and keep it at a safe place so you can use it later. The hash string is always 60 symbols, regardless of the actual length of your generated password.
47-
- *Key* – to generate a key, you need to set its size, which must be at least 16 and no longer than 128 bytes.
48-
- *Keyring* – to generate a keyring, you need to set its size, which must be at least 16 and no longer than 64 bytes. You also have to enter a rotation period number – between 30 and 365 days.
51+
- *Key* – to generate a key, you need to set its size, which must be at least 16 and no more than 128 bytes.
52+
- *Keyring* – to generate a keyring, you need to set its size, which must be at least 16 and no more than 64 bytes. You also have to enter a rotation period, which must be at least 30 and no more than 365 days.
53+
54+
10. Select the initial status of your credential \(**Enabled**, **Read-only**, or **Disabled**\). You can change this setting later.
55+
56+
11. Choose whether your credential to be modifiable or not.
57+
58+
> ### Note:
59+
> Once a credential is set to *Unmodifiable*, its properties cannot be further changed – except for the *Status* attribute.
60+
>
61+
> Also, unmodifiable credentials can be deleted only after being disabled for at least 7 days.
4962
50-
9. Select the initial status of your credential \(**Enabled**, **Read-only**, **Disabled**\).
63+
12. \(Optional\) Enter your username so other subaccount administrators would know that this namespace and credential were created by you.
5164

52-
10. \(Optional\) You can enter a username and some metadata, which to associate with your credential.
65+
13. \(Optional\) Enter some metadata that can be associated with your credential.
5366

54-
11. Choose *Create*.
67+
14. Choose *Create*.
5568

5669

5770

@@ -68,10 +81,10 @@ The new namespace appears in the table.
6881

6982
## Next Steps
7083

71-
If you want to delete an obsolete namespace, choose ![](images/CS_delete_credential_32c1346.png) \(*Delete*\).
84+
If you want to delete an obsolete namespace, choose <span style="color:#007cc0;"><span class="SAP-icons-V5"></span></span> \(Delete\).
7285

7386
> ### Note:
74-
> If your namespace contains keyrings, they have to be in status **Disabled** and have stayed disabled for at least 7 days so you can be allowed to delete the namespace. This is a security precaution that protects your keyrings from unintentional deletion.
87+
> If your namespace contains keyrings, they have to be in status **Disabled** and should have stayed disabled for at least 7 days so you can be allowed to delete the namespace. This is a security precaution that protects your keyrings from unintentional deletion.
7588
7689
**Related Information**
7790

docs/admin-and-ops/create-download-and-delete-a-service-key-7502e17.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<!-- loio7502e1780e5b46f7982f8cc2a37a0080 -->
22

3+
<link rel="stylesheet" type="text/css" href="../css/sap-icons.css"/>
4+
35
# Create, Download, and Delete a Service Key
46

57
To use a service instance from an external application or an application deployed in another space, you need to create a service key.
@@ -10,9 +12,7 @@ To use a service instance from an external application or an application deploye
1012

1113
## Prerequisites
1214

13-
- You've enabled SAP Credential Store for your subaccount on your Cloud Foundry or Kyma space. See: [Initial Setup](../initial-setup-d5f1ce7.md)
14-
15-
- You've created a service instance for SAP Credential Store. See: [Create a Service Instance](create-a-service-instance-dc5f087.md)
15+
- You've [created a service instance](create-a-service-instance-dc5f087.md) for SAP Credential Store.
1616

1717
- You've downloaded and installed the [Cloud Foundry command line interface](https://help.sap.com/products/BTP/65de2977205c403bbc107264b8eccf4b/4ef907afb1254e8286882a2bdef0edf4.html) \(cf CLI\).
1818

@@ -37,29 +37,32 @@ You can create a service key in two ways:
3737
> ### Note:
3838
> For newly created service keys, the default validity is **60** days. This applies to service instances with all types of authentication \(`basic`, `mtls`, `oauth:key`, and `oauth:mtls`\).
3939
>
40-
> If you want to change the service key validity, go to the service instance and choose *Credential Store* \> *Settings* \> *Edit Configuration*.
40+
> If you want to change the service key validity, go to the service instance and choose *Credential Store* \> *Settings* \> *Edit Configuration* \> *Binding Validity*.
4141
4242
4343
4444
## Procedure
4545
46-
1. From the left-side navigation menu, choose *Services* \> *Instances*.
46+
1. In the SAP BTP cockpit, navigate to your subaccount and space.
4747
48-
2. Select a *Credential Store* instance.
48+
2. From the left-side navigation menu, choose *Services* \> *Instances*.
4949
50-
3. From the left-side navigation menu, choose *Service Keys*.
50+
3. Select a *Credential Store* instance.
5151
52-
4. Choose *Create Service Key*.
52+
4. From the left-side navigation menu, choose *Service Keys*.
5353
54-
5. Enter a name for the new service key.
54+
5. Choose *Create Service Key*.
5555
56-
6. \(Optional\) Define configuration parameters in JSON format for this service key.
56+
6. Enter a name for the new service key.
5757
58-
The parameters are the same as in **step 4** in task [Bind a Service Instance](bind-a-service-instance-0aead0c.md).
58+
7. \(Optional\) Define configuration parameters in JSON format for this service key.
5959
60-
7. Choose *Save*. The service key is created.
60+
The parameters are the same as in **step 5** in task [Bind a Service Instance](bind-a-service-instance-0aead0c.md).
6161
62-
The properties are the same as the ones in task [Bind a Service Instance](bind-a-service-instance-0aead0c.md).
62+
8. Choose *Save*. The service key is created.
63+
64+
> ### Tip:
65+
> The relevant properties in the VCAP\_SERVICES environment variable are the same as the ones described in [Bind a Service Instance: Next Steps](https://help.sap.com/docs/credential-store/sap-credential-store/bind-service-instance?version=Cloud#next-steps).
6366
6467
6568
@@ -68,8 +71,15 @@ You can create a service key in two ways:
6871
6972
## Next Steps
7073
71-
- To download a service key, choose ![](images/CS_save_as_JSON_27dc49d.png) \(*Save JSON to file*\).
74+
- To download a service key, choose <span style="color:#007cc0;"><span class="SAP-icons-V5"></span></span> \(Save JSON to file\).
75+
76+
- To delete an obsolete service key, choose <span style="color:#007cc0;"><span class="SAP-icons-V5"></span></span> \(Delete Service Key\).
77+
78+
79+
**Related Information**
80+
7281
73-
- To delete an obsolete service key, choose ![](images/CS_delete_credential_32c1346.png) \(*Delete Service Key*\).
82+
[Bind a Service Instance](bind-a-service-instance-0aead0c.md "Bind a SAP Credential Store instance to your Cloud Foundry or Kyma application to enable the automatic delivery of credentials needed to access the service instance from this application.")
7483
84+
[Cloud Foundry: VCAP\_SERVICES](https://docs.cloudfoundry.org/devguide/deploy-apps/environment-variable.html#VCAP-SERVICES)
7585

0 commit comments

Comments
 (0)