Skip to content

Commit 0bab7a8

Browse files
committed
sample: from-zero-to-cap-on-kyma
- Update as per feedback
1 parent 4c1a4f6 commit 0bab7a8

3 files changed

Lines changed: 17 additions & 7 deletions

File tree

from-zero-to-cap-on-kyma/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Using this sample, you start from scratch to deploy a [CAP](https://cap.cloud.sa
2121
- [NodeJS 20 or higher](https://nodejs.org/en/download/)
2222
- [SAP CAP](../prerequisites/README.md#sap-cap)
2323
- SAP Hana Cloud Instance
24+
- Entitlement for `hdi-shared` plan for Hana cloud service in your SAP BTP subaccount.
2425
- [SAP Hana Cloud Instance mapped to Kyma](https://blogs.sap.com/2022/12/15/consuming-sap-hana-cloud-from-the-kyma-environment/)
2526

2627
## CAP Application
@@ -68,7 +69,7 @@ Using this sample, you start from scratch to deploy a [CAP](https://cap.cloud.sa
6869
```
6970

7071
> [!Note]
71-
> The standalone Application Router is used to simplify the setup and **is not a must**. It should be also possible to use the managed approuter because your CAP APIs are exposed via Fiori or UI5 applications and accessed using workzone.
72+
> The standalone Application Router is used to simplify the setup and **is not a must**. It should also be possible to use the managed approuter because your CAP APIs are exposed via Fiori or UI5 applications and accessed using workzone.
7273
7374
### Configuring Environment Variables
7475

@@ -112,8 +113,12 @@ Using this sample, you start from scratch to deploy a [CAP](https://cap.cloud.sa
112113
```
113114

114115
3. Enable Istio injection for the namespace. Set the kubeconfig context to point to the namespace and create the Docker image pull Secret.
115-
116-
> Note: You will need a Docker API Key so that Kubernetes can pull the Docker images from your Docker account.
116+
117+
> [!Note]
118+
> - You will need a Docker API Key so that Kubernetes can pull the Docker images from your Docker account.
119+
> - `docker server` could be e.g. `https://index.docker.io/v1/` or your private docker registry server. **For this example, you may use the public Docker registry. However the recommended approach is to use a private Docker registry**.
120+
> - `docker user` is the username of your docker registry account.
121+
> - `docker password` is the API Key of your docker registry account.
117122

118123
```shell
119124
make prepare-kyma-for-deployment

from-zero-to-cap-on-kyma/create-docker-pull-secret.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ echo -n "Your docker user: "; read YOUR_USER
66
echo -n "Your email: "; read YOUR_EMAIL
77
echo -n "Your API key: "; read -s YOUR_API_KEY
88
kubectl -n ${NAMESPACE} create secret docker-registry \
9-
"docker-config" \
9+
"docker-registry" \
1010
"--docker-server=$YOUR_DOCKER_SERVER" \
1111
"--docker-username=$YOUR_USER" \
1212
"--docker-password=$YOUR_API_KEY" \

from-zero-to-cap-on-kyma/the-detailed-path.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Using this sample, you start from scratch to deploy a [CAP](https://cap.cloud.sa
2121
- [NodeJS 20 or higher](https://nodejs.org/en/download/)
2222
- [SAP CAP](../prerequisites/README.md#sap-cap)
2323
- SAP Hana Cloud Instance
24+
- Entitlement for `hdi-shared` plan for Hana cloud service in your SAP BTP subaccount.
2425
- [SAP Hana Cloud Instance mapped to Kyma](https://blogs.sap.com/2022/12/15/consuming-sap-hana-cloud-from-the-kyma-environment/)
2526

2627
## Initializing CAP Application
@@ -35,8 +36,8 @@ Using this sample, you start from scratch to deploy a [CAP](https://cap.cloud.sa
3536
- Data model defined in [./bookshop/db/schema.cds](./bookshop/db/schema.cds). <!-- markdown-link-check-disable-line -->
3637
- CDS defined in [./bookshop/srv/cat-service.cds](./bookshop/srv/cat-service.cds). <!-- markdown-link-check-disable-line -->
3738

38-
> [!NOTE]
39-
> CAP promotes getting started with minimal upfront setup, based on convention over configuration, and a grow-as-you-go approach, adding settings and tools later on, only when you need them. For more information, see [Introduction to CAP](https://cap.cloud.sap/docs/about/).
39+
> [!NOTE]
40+
> CAP promotes getting started with minimal upfront setup, based on convention over configuration, and a grow-as-you-go approach, adding settings and tools later on, only when you need them. For more information, see [Introduction to CAP](https://cap.cloud.sap/docs/about/).
4041
4142
2. Run the application locally
4243

@@ -117,7 +118,11 @@ Using this sample, you start from scratch to deploy a [CAP](https://cap.cloud.sa
117118

118119
3. Enable Istio injection for the namespace. Set the kubeconfig context to point to the namespace and create the Docker image pull Secret.
119120

120-
> Note: You will need a Docker API Key so that Kubernetes can pull the Docker images from your Docker account.
121+
> [!Note]
122+
> - You will need a Docker API Key so that Kubernetes can pull the Docker images from your Docker account.
123+
> - `docker server` could be e.g. `https://index.docker.io/v1/` or your private docker registry server. **For this example, you may use the public Docker registry. However the recommended approach is to use a private Docker registry**.
124+
> - `docker user` is the username of your docker registry account.
125+
> - `docker password` is the API Key of your docker registry account.
121126

122127
```shell
123128
make prepare-kyma-for-deployment

0 commit comments

Comments
 (0)