diff --git a/website/content/en/docs/configuration/_index.md b/website/content/en/docs/configuration/_index.md index b2a9cd0..0720601 100644 --- a/website/content/en/docs/configuration/_index.md +++ b/website/content/en/docs/configuration/_index.md @@ -13,8 +13,8 @@ Here's a list of environment variables used by CAP Operator. ### Controller - `CERT_MANAGER`: specifies the certificate manager to be used for TLS certificates. Possible values are: - - `gardener`: [Gardener certificate management](https://github.com/gardener/cert-management) + - `gardener`: ["Gardener" certificate management](https://github.com/gardener/cert-management) - `cert-manager.io`: [cert-manager.io cert-manager](https://github.com/cert-manager/cert-manager) - `DNS_MANAGER`: specifies the external DNS manager to be used. Possible values are: - - `gardener`: [Gardener external DNS manager](https://github.com/gardener/external-dns-management) + - `gardener`: ["Gardener" external DNS manager](https://github.com/gardener/external-dns-management) - `kubernetes`: [external DNS management from Kubernetes](https://github.com/kubernetes-sigs/external-dns) diff --git a/website/content/en/docs/installation/prerequisites.md b/website/content/en/docs/installation/prerequisites.md index b3d9d67..db3df9c 100644 --- a/website/content/en/docs/installation/prerequisites.md +++ b/website/content/en/docs/installation/prerequisites.md @@ -7,7 +7,7 @@ description: > How to prepare the cluster before installing CAP Operator --- -We recommend that you use a [Gardener](https://gardener.cloud/)-managed cluster to deploy CAP applications that are managed with CAP Operator. +We recommend that you use a "[Gardener](https://gardener.cloud/)" managed cluster to deploy CAP applications that are managed with CAP Operator. The Kubernetes cluster must be set up with the following prerequisites before you install CAP Operator: ##### [Istio](https://istio.io/latest/docs/concepts/traffic-management/) (version >= 1.12) @@ -24,6 +24,6 @@ These operators can be used for managing SAP BTP service instances and service b > Please note that service credentials added as Kubernetes Secrets to a namespace by these operators, support additional metadata. If you don't use this feature of these operators, use `secretKey: credentials` in the spec of these operators to ensure that the service credentials retain any JSON data as it is. **We recommend that you use `secretKey`, even when credential metadata is available to reduce the overhead of interpreting parsing multiple JSON attributes.** -##### [Gardener certificate management](https://github.com/gardener/cert-management) +##### ["Gardener" certificate management](https://github.com/gardener/cert-management) -This component is available in clusters managed by Gardener and will be used to manage TLS certificates and issuers. Gardener manages encryption, issuing, and signing of certificates. Alternatively, you can use [cert-manager.io cert-manager](https://github.com/cert-manager/cert-manager). \ No newline at end of file +This component is available in clusters managed by "Gardener" and will be used to manage TLS certificates and issuers. "Gardener" manages encryption, issuing, and signing of certificates. Alternatively, you can use [cert-manager.io cert-manager](https://github.com/cert-manager/cert-manager). \ No newline at end of file diff --git a/website/content/en/docs/usage/deploying-application.md b/website/content/en/docs/usage/deploying-application.md index e98f4c9..496e29c 100644 --- a/website/content/en/docs/usage/deploying-application.md +++ b/website/content/en/docs/usage/deploying-application.md @@ -119,7 +119,7 @@ The controller component of CAP Operator reacts to these objects and creates fur - Deployment (and service) for the application server with credentials (from secrets) to access SAP BTP services injected as `VCAP_SERVICES` environment variable - Deployment (and service) for the approuter with destination mapping to the application server and subscription server (for the tenant provisioning route) - Job for the version content deployer -- TLS certificates for the domains provided using either [Gardener cert-management](https://github.com/gardener/cert-management) or [cert-manager.io cert-manager](https://github.com/cert-manager/cert-manager) +- TLS certificates for the domains provided using either ["Gardener" cert-management](https://github.com/gardener/cert-management) or [cert-manager.io cert-manager](https://github.com/cert-manager/cert-manager) - Istio gateway resource for the application domains > The content deployer is used to deploy content or configuration to SAP BTP services, before using them. diff --git a/website/content/en/docs/usage/prerequisites.md b/website/content/en/docs/usage/prerequisites.md index 8242893..bd25e7b 100644 --- a/website/content/en/docs/usage/prerequisites.md +++ b/website/content/en/docs/usage/prerequisites.md @@ -21,7 +21,7 @@ Other services (not listed here) may also be used depending on the requirement ( ##### SAP Authorization and Trust Management Service -The parameter `oauth2-configuration.redirect-uris` must include the domain used by the application. If the application is hosted in a Gardener (Canary)-managed cluster, the entry will have the form `https://*...shoot.url.k8s.example.com/**`. +The parameter `oauth2-configuration.redirect-uris` must include the domain used by the application. For instance, if the application is hosted in a "Gardener" managed cluster, the entry may have the form `https://*...shoot.url.k8s.example.com/**`. Scope required to make asynchronous tenant subscription operations need to be included. Additionally, check the [CAP Multitenancy](https://cap.cloud.sap/docs/java/multitenancy#xsuaa-mt-configuration) documentation for additional scopes which are required. diff --git a/website/content/en/docs/usage/resources/capapplication.md b/website/content/en/docs/usage/resources/capapplication.md index 3e9b3c3..7b26a30 100644 --- a/website/content/en/docs/usage/resources/capapplication.md +++ b/website/content/en/docs/usage/resources/capapplication.md @@ -62,7 +62,7 @@ The overall list of SAP BTP service instances and respective Secrets (credential The `provider` section specifies details of the provider subaccount linked to this application, while `globalAccountId` denotes the global account in which the provider subaccount is created. Within a global account, the `btpAppName` has to be unique as this is equivalent to `XSAPPNAME`, which is used in various SAP BTP service and application constructs. -The `domains` section provides details of where the application routes are exposed. Within a Gardener cluster, the primary application domain is a subdomain of the cluster domain, and Gardener [cert-management](https://github.com/gardener/cert-management) will be used to request a wildcard TLS certificate for the primary domain. Additional secondary domains may also be specified (for example, for customer-specific domains) for the application. +The `domains` section provides details of where the application routes are exposed. Within a "Gardener" cluster, the primary application domain is a subdomain of the cluster domain, and "Gardener" [cert-management](https://github.com/gardener/cert-management) will be used to request a wildcard TLS certificate for the primary domain. Additional secondary domains may also be specified (for example, for customer-specific domains) for the application. > NOTE: While the same secondary domain can technically be used across applications; the consumers need to ensure that the tenant sub-domains are unique across such applications that share the same domain! `istioIngressGatewayLabels` are key-value pairs (string) used to identify the ingress controller component of Istio and the related load balancer service. These values are configured during the installation of Istio service mesh in the cluster. diff --git a/website/static/img/workflow.png b/website/static/img/workflow.png index 58121b7..e8a4311 100644 Binary files a/website/static/img/workflow.png and b/website/static/img/workflow.png differ