Skip to content

Commit

Permalink
Update from SAP DITA CMS (squashed):
Browse files Browse the repository at this point in the history
commit 692f73e5998fd8e64c6cfb4e2f56185a330694b3
Author: REDACTED
Date:   Mon Mar 18 21:51:34 2024 +0000

    Update from SAP DITA CMS 2024-03-18 21:51:34
    Project: dita-all/nyp1624030053288
    Project map: 70650142b4cd4adb8d822844257a3872.ditamap
    Language: en-US

commit fb7c8e991e7888a9738ce586447ba3e823260c1e
Author: REDACTED
Date:   Mon Mar 18 21:36:55 2024 +0000

    Update from SAP DITA CMS 2024-03-18 21:36:55
    Project: dita-all/nyp1624030053288
    Project map: 70650142b4cd4adb8d822844257a3872.ditamap
    Language: en-US

commit 2010ff8bb543bc246281bdf75443b8c6f745d3a0
Author: REDACTED
Date:   Mon Mar 18 21:06:35 2024 +0000

    Update from SAP DITA CMS 2024-03-18 21:06:35
    Project: dita-all/nyp1624030053288
    Project map: 70650142b4cd4adb8d822844257a3872.ditamap
    Language: en-US

commit 1f5e55bb3a1b6fd2ed7c8c13e95230a8daf49209
Author: REDACTED
Date:   Sat Mar 9 15:06:40 2024 +0000

    Update from SAP DITA CMS 2024-03-09 15:06:40

##################################################
[Remaining squash message was removed before commit...]
  • Loading branch information
ditaccms-bot committed Mar 21, 2024
1 parent 826600c commit 7bd7abd
Show file tree
Hide file tree
Showing 19 changed files with 916 additions and 225 deletions.
2 changes: 1 addition & 1 deletion docs/cicd/api-usage-ae2f233.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# API Usage

> ### Note:
> This section is only relevant if you have enabled API usage for SAP Continuous Integration and Delivery. See [\(Optional\) Enabling the API Usage](optional-enabling-the-api-usage-1aedc23.md).
> This section is only relevant if you have enabled API usage for SAP Continuous Integration and Delivery. See [Enabling the API Usage](enabling-the-api-usage-1aedc23.md).
It is recommended to rotate the service keys for API usage regularly, that is, by creation of new keys and deletion of the retired keys. Service keys can be created within the SAP BTP cockpit or by using the Cloud Foundry command line interface. See [Creating Service Keys](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/4514a14ab6424d9f84f1b8650df609ce.html).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Depending on your configuration, the Cloud Foundry Environment pipeline can comp
Choose the build tool version you want to use. For more information, see [Supported Tools](supported-tools-5949283.md).

If you don't define a build tool version, a default one \(`MBTJ11N14`\) is used.
If you don't define a build tool version, the latest one is used by default.

</td>
</tr>
Expand Down Expand Up @@ -318,7 +318,7 @@ Depending on your configuration, the Cloud Foundry Environment pipeline can comp
</td>
<td valign="top">
To authenticate your pipeline against the Cloud Foundry API endpoint, create a Basic Authentication credential of a user, who has the appropriate permissions. The user must have the Space Developer role and be a member of the specified Cloud Foundry organization and space. See [Creating Credentials](creating-credentials-6658c81.md).
To authenticate your pipeline against the Cloud Foundry API endpoint, either create a Basic Authentication or a Basic Authentication for Custom IdP credential of a user who has the appropriate permissions. The user must have the Space Developer role and be a member of the specified Cloud Foundry organization and space. See [Creating Credentials](creating-credentials-6658c81.md).

> ### Tip:
> Use a technical user instead of your personal credentials.
Expand Down Expand Up @@ -394,7 +394,7 @@ Depending on your configuration, the Cloud Foundry Environment pipeline can comp
</td>
<td valign="top">
\(Optional\) To authenticate your pipeline against the application, create a *Basic Authentication* credential of a user, who has the appropriate permissions. See [Creating Credentials](creating-credentials-6658c81.md).
\(Optional\) To authenticate your pipeline against the application, create a *Basic Authentication* credential of a user who has the appropriate permissions. See [Creating Credentials](creating-credentials-6658c81.md).

Choose this credential from the dropdown list.

Expand Down Expand Up @@ -470,7 +470,7 @@ Depending on your configuration, the Cloud Foundry Environment pipeline can comp
</td>
<td valign="top">
\(Optional\) To authenticate your pipeline against the application, create a *Basic Authentication* credential of a user, who has the appropriate permissions. See [Creating Credentials](creating-credentials-6658c81.md).
\(Optional\) To authenticate your pipeline against the application, create a *Basic Authentication* credential of a user who has the appropriate permissions. See [Creating Credentials](creating-credentials-6658c81.md).

> ### Tip:
> Avoid using a technical user credential and create a special test user instead.
Expand Down Expand Up @@ -740,7 +740,7 @@ Depending on your configuration, the Cloud Foundry Environment pipeline can comp
</td>
<td valign="top">
To authenticate your pipeline against the Cloud Foundry API endpoint, create a Basic Authentication credential of a user, who has the appropriate permissions. The user must have the Space Developer role and be a member of the specified Cloud Foundry organization and space. See [Creating Credentials](creating-credentials-6658c81.md).
To authenticate your pipeline against the Cloud Foundry API endpoint, either create a Basic Authentication or a Basic Authentication for Custom IdP credential of a user who has the appropriate permissions. The user must have the Space Developer role and be a member of the specified Cloud Foundry organization and space. See [Creating Credentials](creating-credentials-6658c81.md).
> ### Tip:
> Use a technical user instead of your personal credentials.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Depending on your configuration, the SAP Fiori for the ABAP platform pipeline ca
Choose the build tool version you want to use. For more information, see [Supported Tools](supported-tools-5949283.md).

If you don't define a build tool version, a default one \(`N14`\) is used.
If you don't define a build tool version, the latest one is used by default.

</td>
</tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ Configure the stages of your SAP Fiori in the Cloud Foundry environment job dire

## Prerequisites

> ### Caution:
> This pipeline type is deprecated. Please use the [Cloud Foundry Environment](cloud-foundry-environment-7c2a049.md) pipeline with the mta build tool, instead. All existing jobs will be migrated automatically.
- You’re an administrator of SAP Continuous Integration and Delivery. See [Assigning Roles and Permissions](assigning-roles-and-permissions-c679ebd.md).

- In your source code management system, you have an SAPUI5/SAP Fiori project for the Cloud Foundry environment. See [Create an SAP Fiori Project](https://help.sap.com/viewer/9d1db9835307451daa8c930fbd9ab264/Cloud/en-US/46664de4d6944471b6c29a0681bfd0fc.html).
Expand Down Expand Up @@ -101,7 +104,7 @@ Depending on your configuration, the SAP Fiori in the Cloud Foundry environment
Choose the build tool version you want to use. For more information, see [Supported Tools](supported-tools-5949283.md).

If you don't define a build tool version, a default one \(`MBTJ11N14`\) is used.
If you don't define a build tool version, the latest one is used by default.

</td>
</tr>
Expand Down Expand Up @@ -345,7 +348,7 @@ Depending on your configuration, the SAP Fiori in the Cloud Foundry environment
</td>
<td valign="top">
To authenticate your pipeline against the Cloud Foundry API endpoint, create a Basic Authentication credential of a user, who has the appropriate permissions. The user must have the Space Developer role and be a member of the specified Cloud Foundry organization and space. See [Creating Credentials](creating-credentials-6658c81.md).
To authenticate your pipeline against the Cloud Foundry API endpoint, either create a Basic Authentication or a Basic Authentication for Custom IdP credential of a user who has the appropriate permissions. The user must have the Space Developer role and be a member of the specified Cloud Foundry organization and space. See [Creating Credentials](creating-credentials-6658c81.md).

> ### Tip:
> Use a technical user instead of your personal credentials.
Expand Down Expand Up @@ -419,7 +422,7 @@ Depending on your configuration, the SAP Fiori in the Cloud Foundry environment
</td>
<td valign="top">
\(Optional\) To authenticate your pipeline against the application, create a Basic Authentication credential of a user, who has the appropriate permissions. See [Creating Credentials](creating-credentials-6658c81.md).
\(Optional\) To authenticate your pipeline against the application, create a Basic Authentication credential of a user who has the appropriate permissions. See [Creating Credentials](creating-credentials-6658c81.md).

> ### Tip:
> Avoid using a technical user credential and create a special test user instead.
Expand Down Expand Up @@ -511,7 +514,7 @@ Depending on your configuration, the SAP Fiori in the Cloud Foundry environment
</td>
<td valign="top">
\(Optional\) To authenticate your pipeline against the application, create a *Basic Authentication* credential of a user, who has the appropriate permissions. See [Creating Credentials](creating-credentials-6658c81.md).
\(Optional\) To authenticate your pipeline against the application, create a *Basic Authentication* credential of a user who has the appropriate permissions. See [Creating Credentials](creating-credentials-6658c81.md).
> ### Tip:
> Avoid using a technical user credential and create a special test user instead.
Expand Down Expand Up @@ -660,7 +663,7 @@ Depending on your configuration, the SAP Fiori in the Cloud Foundry environment
</td>
<td valign="top">
To authenticate your pipeline against your SonarQube instance, create a *Secret Text* credential of a user, who has the appropriate permissions. See [Creating Credentials](creating-credentials-6658c81.md).
To authenticate your pipeline against your SonarQube instance, create a *Secret Text* credential of a user who has the appropriate permissions. See [Creating Credentials](creating-credentials-6658c81.md).
In the *Secret* text field, paste the token that was generated when creating your SonarQube project. If you are unable to retrieve your token, generate a new one. See [Generating and Using Tokens](https://docs.sonarqube.org/latest/user-guide/user-token/).
Expand Down Expand Up @@ -781,7 +784,7 @@ Depending on your configuration, the SAP Fiori in the Cloud Foundry environment
</td>
<td valign="top">
To authenticate your pipeline against the Cloud Foundry API endpoint, create a Basic Authentication credential of a user, who has the appropriate permissions. The user must have the Space Developer role and be a member of the specified Cloud Foundry organization and space. See [Creating Credentials](creating-credentials-6658c81.md).
To authenticate your pipeline against the Cloud Foundry API endpoint, either create a Basic Authentication or a Basic Authentication for Custom IdP credential of a user who has the appropriate permissions. The user must have the Space Developer role and be a member of the specified Cloud Foundry organization and space. See [Creating Credentials](creating-credentials-6658c81.md).
> ### Tip:
> Use a technical user instead of your personal credentials.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ Configure the stages of your SAP Fiori in the Cloud Foundry environment job in y

## Prerequisites

> ### Caution:
> This pipeline type is deprecated. Please use the [Cloud Foundry Environment](cloud-foundry-environment-7c2a049.md) pipeline with the mta build tool, instead. All existing jobs will be migrated automatically.
- You’re an administrator of SAP Continuous Integration and Delivery. See [Assigning Roles and Permissions](assigning-roles-and-permissions-c679ebd.md).

- In your source code management system, you have an SAPUI5/SAP Fiori project for the Cloud Foundry environment. See [Create an SAP Fiori Project](https://help.sap.com/viewer/9d1db9835307451daa8c930fbd9ab264/Cloud/en-US/46664de4d6944471b6c29a0681bfd0fc.html).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Depending on your configuration, the SAP Fiori in the Neo environment pipeline c
Choose the build tool version you want to use. For more information, see [Supported Tools](supported-tools-5949283.md).

If you don't define a build tool version, a default one \(`MBTJ11N14`\) is used.
If you don't define a build tool version, the latest one is used by default.

</td>
</tr>
Expand Down
96 changes: 55 additions & 41 deletions docs/cicd/creating-credentials-6658c81.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ Configure credentials for connecting SAP Continuous Integration and Delivery to

## Prerequisites

- You set up SAP Continuous Integration and Delivery. See [Initial Setup](initial-setup-719acaf.md).
- You've set up SAP Continuous Integration and Delivery. See [Initial Setup](initial-setup-719acaf.md).

- You’re an administrator of SAP Continuous Integration and Delivery. See [Assigning Roles and Permissions](assigning-roles-and-permissions-c679ebd.md).
- You’re assigned the Administrator role for SAP Continuous Integration and Delivery. See [Assigning Roles and Permissions](assigning-roles-and-permissions-c679ebd.md).




## Context

During each job, SAP Continuous Integration and Delivery connects to other services \(for example, to GitHub, GitLab, Bitbucket Server, or Azure DevOps to clone your sources, and to SAP BTP to deploy your built application\). To authenticate SAP Continuous Integration and Delivery against these services, you have to configure credentials that can be referenced by a job. Each credential is stored under a unique name in your subaccount.
During each job, SAP Continuous Integration and Delivery connects to other services \(for example, to GitHub or another source code management system to clone your sources, and to SAP BTP to deploy your application\). To authenticate SAP Continuous Integration and Delivery against these services, you need to configure credentials that can be referenced by a job. Each credential is stored under a unique name in your subaccount.



Expand All @@ -31,8 +31,6 @@ During each job, SAP Continuous Integration and Delivery connects to other servi

2. In the *Create Credentials* pop-up, enter the following values:

**Values for Creating Credentials in SAP Continuous Integration and Delivery**


<table>
<tr>
Expand All @@ -55,14 +53,14 @@ During each job, SAP Continuous Integration and Delivery connects to other servi
</td>
<td valign="top">

. SeeFreely choose a unique name for your credential, for example, "`this-is--an.example.name`".
Freely choose a unique name for your credential.

Valid credential names:
To provide a valid credential name, adhere to the following rules:

- start and end with an alphanumeric character \(invalid: "`-name.`"\)
- contain only lowercase letters, numbers, hyphens, and dots \(invalid: "`CamelCase`"\)
- cannot contain dots next to each other or dots next to hyphens \(invalid: "`name..1`" or "`name-.-2`"\)
- have a maximum length of 253 characters
- Start and end with an alphanumeric character.
- Only use lowercase letters, numbers, hyphens, and dots.
- Do not use dots next to each other or dots next to hyphens.
- Only use a maximum of 253 characters.



Expand Down Expand Up @@ -90,36 +88,13 @@ During each job, SAP Continuous Integration and Delivery connects to other servi

From the drop-down list, choose the authentication type of your credential.

SAP Continuous Integration and Delivery supports the following authentication types:

- Basic Authentication

- OAuth

- Service Key

- Secret Text

- Cloud Connector

- Webhook Secret

- Container Registry Configuration

- Kubernetes Configuration


Different steps within a job require different credential types. For more information, see [Supported Pipelines](supported-pipelines-e293286.md).
For more information on which credential type is needed for which step within a job, see [Supported Pipelines](supported-pipelines-e293286.md).

</td>
</tr>
</table>

Depending on which *Type* you choose, you're asked for additional values.

3. In the following table, look for your authentication type and enter the necessary values in the *Add Credential* popup.

**Additional Values per Authentication Type**
3. Depending on which type you choose, you're asked for additional values:


<table>
Expand Down Expand Up @@ -167,6 +142,47 @@ During each job, SAP Continuous Integration and Delivery connects to other servi

Enter your password for the Basic Authentication credential.

</td>
</tr>
<tr>
<td valign="top" rowspan="3">

Basic Authentication for Custom IdP

</td>
<td valign="top">

Username

</td>
<td valign="top">

Enter your username for the Basic Authentication for Custom IdP credential.

</td>
</tr>
<tr>
<td valign="top">

Password

</td>
<td valign="top">

Enter your password for the Basic Authentication for Custom IdP credential.

</td>
</tr>
<tr>
<td valign="top">

Origin Key

</td>
<td valign="top">

Enter the origin key to connect to Cloud Foundry. You can find it in your subaccount in the SAP BTP cockpit under *Cloud Foundry* \> *Org Members* in the *Origin* column.

</td>
</tr>
<tr>
Expand Down Expand Up @@ -244,7 +260,7 @@ During each job, SAP Continuous Integration and Delivery connects to other servi

Create a service key in the space of the service instance to which you want to connect SAP Continuous Integration and Delivery. See [Creating Service Keys](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/4514a14ab6424d9f84f1b8650df609ce.html).

Copy and paste this service key in the json format into the *Service Key* text field.
Copy and paste this service key in the JSON format into the *Service Key* text field.

</td>
</tr>
Expand Down Expand Up @@ -298,9 +314,7 @@ During each job, SAP Continuous Integration and Delivery connects to other servi
Freely enter a secret or choose the *Generate* button to generate a secret for your webhook.

> ### Caution:
> The secret will only be visible during the creation of the webhook credential.
>
> Make sure to copy and store it some place safe before closing the dialog. You need this secret to create a webhook in your source code repository. See, for example, [Add a Webhook in GitHub](add-a-webhook-in-github-090d4aa.md).
> This secret is only visible during the creation of the webhook credential. Make sure to copy and save it before closing the dialog.


Expand Down Expand Up @@ -350,7 +364,7 @@ During each job, SAP Continuous Integration and Delivery connects to other servi
This is a YAML document used by the Kubernetes client to authenticate a Kubernetes cluster.
Use a Kubernetes configuration that contains an access token for a suitable service account. If you need instructions on how to create the service account and the configuration, use this [tutorial](https://developers.sap.com/tutorials/kyma-create-service-account.html). The required permissions \(Kubernetes roles and cluster roles\) of the service account depend on the types of resources that are created or updated during the deployment.
Use a Kubernetes configuration that contains an access token for a suitable service account. For how to create the service account and the configuration, see [Create a Kyma service account](https://developers.sap.com/tutorials/kyma-create-service-account.html). The required permissions \(Kubernetes roles and cluster roles\) of the service account depend on the types of resources that are created or updated during the deployment.
> ### Note:
> For Kyma environments, you can't use a Kubernetes configuration downloaded from the SAP BTP cockpit because it only supports interactive signon.
Expand Down
Loading

0 comments on commit 7bd7abd

Please sign in to comment.