Skip to content

Commit

Permalink
[Docs] CAP Operator CRO doc update (#103)
Browse files Browse the repository at this point in the history
  • Loading branch information
anirudhprasad-sap authored Dec 9, 2024
1 parent 3f514be commit 99f7129
Showing 1 changed file with 34 additions and 2 deletions.
36 changes: 34 additions & 2 deletions content/en/docs/resources/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,21 @@ description: >

CAP Operator Manager uses resource `CAPOperator` to install the CAP Operator. The `CAPOperator` resource has the following attributes -

- `subscriptionServer.subDomain` _string_ - Subdomain of the CAP Operator subscription Server
- `subscriptionServer.certificateManager` _string_ - Certificate manager which can be set to either `Gardener` or `CertManager`, with the default value being `Gardener`
- `subscriptionServer.certificateConfig.gardener` - Configuration for Gardener certificates, applicable only if `subscriptionServer.certificateManager` is set to `Gardener`. This allows you to specify the `issuerName` and `issuerNamespace`.
- `subscriptionServer.certificateConfig.certManager` - Configuration for CertManager certificates, applicable only if `subscriptionServer.certificateManager` is set to `CertManager`. This allows you to specify the `issuerGroup`, `issuerKind` and `issuerName`.
- `dnsTarget` _string_ - Public ingress URL for the cluster Load Balancer
- `subDomain` _string_ - Subdomain of the CAP Operator subscription Server
- `ingressGatewayLabels` - Labels used to identify the istio ingress-gateway component and its corresponding namespace. Usually {“app”:“istio-ingressgateway”,“istio”:“ingressgateway”}
- `controller.detailedOperationalMetrics` _bool_ - Optionally enable detailed opertational metrics for the controller by setting this to true
- `controller.versionMonitoring.prometheusAddress` _string_ - URL of the Prometheus server from which metrics related to managed application versions can be queried
- `controller.versionMonitoring.metricsEvaluationInterval` - The duration (example 2h) after which versions are evaluated for deletion; based on specified workload metrics
- `controller.versionMonitoring.promClientAcquireRetryDelay` - The duration (example 10m) to wait before retrying to acquire Prometheus client and verify connection, after a failed attempt
- `controller.volumes` - Optionally specify list of additional volumes for the controller pod(s)
- `controller.volumeMounts` - Optionally specify list of additional volumeMounts for the controller container(s)
- `monitoring.enabled` _bool_ - Optionally enable Prometheus monitoring for all components
- `webhook.certificateManager` _string_ - Certificate manager which can be set to either `Default` or `CertManager`, with the default value being `Default`
- `webhook.certificateConfig.certManager` - Configuration for CertManager certificates, applicable only if `webhook.certificateManager` is set to `CertManager`. This allows you to specify the `issuerGroup`, `issuerKind` and `issuerName`.

The below example shows a fully configured `CAPOperator` resource:

Expand All @@ -23,14 +35,34 @@ metadata:
spec:
subscriptionServer:
subDomain: cap-op
certificateManager: Gardener
certificateConfig:
gardener:
issuerName: "gardener-issuer-name"
issuerNamespace: "gardener-issuer-namespace"
ingressGatewayLabels:
- name: istio
value: ingressgateway
- name: app
value: istio-ingressgateway
monitoring:
enabled: true
controller:
detailedOperationalMetrics: true
versionMonitoring:
prometheusAddress: "http://prometheus-operated.monitoring.svc.cluster.local:9090" # <-- example of a Prometheus server running inside the same cluster
promClientAcquireRetryDelay: "2h"
metricsEvaluationInterval: "30m"
webhook:
certificateManager: CertManager
certificateConfig:
certManager:
issuerGroup: "certManager-issuer-group"
issuerKind: "certManager-issuer-kind"
issuerName: "certManager-issuer-name"
```
Here, we will automatically determine the cluster shoot domain and install the CAP Operator by setting the subscription server domain and the DNS Target. The DNS target is derived using the `ingressGatewayLabels`. For the above example, if the determined the cluster shoot domain is `test.stage.kyma.ondemand.com`, then the domain will be set as `cap-op.test.stage.kyma.ondemand.com` by default.
Here, we will automatically determine the cluster shoot domain and install the CAP Operator by setting the subscription server domain and the DNS Target. The DNS target is derived using the `ingressGatewayLabels`. For the above example, if the determined the cluster shoot domain is `test.stage.kyma.ondemand.com`, then the domain will be set as `cap-op.test.stage.kyma.ondemand.com` by default.

>Note: The length of the domain should be less than 64 characters. Depending up on your cluster shoot domain, please choose a length appropriate subdomain.

Expand Down

0 comments on commit 99f7129

Please sign in to comment.