Skip to content

Commit

Permalink
[Misc] Operator: website deps/content updated
Browse files Browse the repository at this point in the history
- update dependencies
- cleanup/address minor issues
  • Loading branch information
Pavan-SAP committed Nov 21, 2024
1 parent 601b13d commit 4b49664
Show file tree
Hide file tree
Showing 10 changed files with 58 additions and 151 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/publish-website.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
- name: Setup Hugo
uses: peaceiris/actions-hugo@v3
with:
hugo-version: "0.134.0"
hugo-version: "0.134.3"
extended: true
- name: Setup Node
uses: actions/setup-node@v4
Expand Down
4 changes: 2 additions & 2 deletions website/content/en/docs/installation/helm/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: >

To install CAP operator components, we recommend using the [Helm chart](https://github.com/sap/cap-operator-lifecycle/tree/main/chart) that is published as an OCI package at `oci://ghcr.io/sap/cap-operator-lifecycle/helm/cap-operator`.

## Installation
### Installation

Create a namespace and install the Helm chart in that namespace by specifying the `domain` and the `dnsTarget` for your subscription server, either

Expand All @@ -32,7 +32,7 @@ Create a namespace and install the Helm chart in that namespace by specifying th
domain: cap-operator.<CLUSTER-DOMAIN>
```
## Optional steps
### Optional steps
- #### Enable Service Monitors for metrics emitted by controller and subscription server
Expand Down
6 changes: 3 additions & 3 deletions website/content/en/docs/installation/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,22 @@ description: >
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.22)
### [Istio](https://istio.io/latest/docs/concepts/traffic-management/) (version >= 1.22)

Istio service mesh is used for HTTP traffic management. CAP Operator creates Istio resources to manage incoming HTTP requests to the application as well as to route requests on specific (tenant) subdomains.

> It's required that you determine the public ingress Gateway subdomain and the overall shoot domain for the system and specify them in the [chart values](../../installation/helm-install/#values)
> Note: Istio promoted many of its [APIs to v1 in 1.22 release](https://istio.io/latest/blog/2024/v1-apis/). Hence as of CAP Operator release v0.11.0 istio version >= 1.22 is a prerequisite.
##### [sap-btp-service-operator](https://github.com/SAP/sap-btp-service-operator) or [cf-service-operator](https://sap.github.io/cf-service-operator/docs/)
### [sap-btp-service-operator](https://github.com/SAP/sap-btp-service-operator) or [cf-service-operator](https://sap.github.io/cf-service-operator/docs/)

These operators can be used for managing SAP BTP service instances and service bindings from within the Kubernetes cluster.

> If some SAP BTP services are not available for Kubernetes platforms, you may use [cf-service-operator](https://sap.github.io/cf-service-operator/), which creates the services for a Cloud Foundry space and inserts the required access credentials as Secrets into the Kubernetes cluster.
> 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).
4 changes: 2 additions & 2 deletions website/content/en/docs/support/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ description: >
How to get support and how to reach out
---

## Bugs
### Bugs

To report a bug, create an [issue](https://github.com/sap/cap-operator/issues).

Anything missing? Please let us know or [raise a PR](https://github.com/sap/cap-operator/pulls).

## Communication Channels
### Communication Channels

Reach out to the project team and the project community via the following communication channels:
- Issues: [GitHub](https://github.com/sap/cap-operator/issues)
Expand Down
12 changes: 6 additions & 6 deletions website/content/en/docs/troubleshoot/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: >
Common issues and how to solve them
---

**Usage of @sap/cds-mtxs library for multitenancy**
### Usage of @sap/cds-mtxs library for multitenancy

> The CAP Operator utilizes the `@sap/cds-mtxs` library. Prior to version 0.7.0 one could disable this by setting the IS_MTXS_ENABLED environment variable to "false" in the TenantOperation workload, in which case the old `@sap/cds-mtx` library-based wrapper job was used instead. However, this is no longer supported and is removed as support for older CDS version (v6) has ended.
Expand Down Expand Up @@ -35,7 +35,7 @@ As of now, for the usage of this new library, you (depending on your k8s cluster
runAsUser: 1000
```
**Secret/credential handling for different workloads of the CAP Operator**
### Secret/credential handling for different workloads of the CAP Operator
Libraries like `xsenv`/`cds`(CAP) handle credentials differently in different environments (CF, K8s) and on K8s when using credential data directly from secrets, any JSON data type information related to the data values may get lost and lead to inconsistencies.

Expand All @@ -57,21 +57,21 @@ spec:

> We recommend that you use `secretKey`, even when credential metadata is available to reduce the overhead of interpreting parsing multiple JSON attributes.

**HTTP requests reaching the AppRouter are not getting forwarded to the application server (pods)**
### HTTP requests reaching the AppRouter are not getting forwarded to the application server (pods)

The Approuter component maps incoming requests to destinations (applications or services) that have been configured. If you're using an `xs-app.json` file with your Approuter to specify route mapping to various destinations, ensure that the `destinationName` property for the
SAP Cloud Application Programming Model back end is specified in the corresponding CAPApplicationVersion configuration. CAP Operator will inject this destination to the Approuter pods (via environment variables).


**HTTP Requests Timing Out in the Approuter for Long-Running Operations in Back End Workload**
### HTTP Requests Timing Out in the Approuter for Long-Running Operations in Back End Workload

If your back-end service is known to take a long time, configure the `destinations` environment variable on the Approuter component to set the desired timeout configuration for that destination (`destinationName`). CAP Operator will overwrite the URL part of that destination to point to the right workload, the remaining settings are taken over exactly as configured.

**Supported Approuter Version**
### Supported Approuter Version

Use `@sap/approuter` version `14.x.x` (or higher).

**CAP Operator Resources Can't Be Deleted in the K8S Cluster/Namespace**
### CAP Operator Resources Can't Be Deleted in the K8S Cluster/Namespace

All custom resource objects (CROs) created by CAP Operator are protected with `finalizers` to ensure a proper cleanup takes place.
For instance, when deleting a `CAPApplication` CRO, any existing tenants would be deprovisioned automatically to avoid inconsistenties. Once the deprovisioning is successful, the corresponding CROs would be removed automatically.
Expand Down
4 changes: 2 additions & 2 deletions website/content/en/docs/usage/tenant-provisioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ spec:
versionUpgradeStrategy: always # <-- always / never
```
## Tenant Provisioning
### Tenant Provisioning
The process of tenant provisioning starts when a consumer subaccount subscribes to the application, either via the SAP BTP cockpit or using the APIs provided by the SaaS provisioning service. This, in turn, initiates the asynchronous callback from the SaaS provisioning service instance into the cluster, and the request is handled by the [subscription server](docs/concepts/operator-components/subscription-server). The subscription server validates the request and creates an instance of `CAPTenant` for the identified `CAPApplication`.

Expand Down Expand Up @@ -58,7 +58,7 @@ The `CAPTenant` reaches a `Ready` state, only after

![tenant-provisioning](/cap-operator/img/activity-tenantprovisioning.drawio.svg)

## Tenant Deprovisioning
### Tenant Deprovisioning

Similar to the tenant provisioning process, when a tenant unsubscribes from the application, the request is received by the subscription server. It validates the existence and status of the `CAPTenant` and submits a request for deletion to the Kubernetes API server.

Expand Down
4 changes: 2 additions & 2 deletions website/content/en/docs/whats-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: >
Discover new features added to CAP Operator
---

#### New updates
### New updates

{{% cardpane %}}
{{% card header="Q4 2024" %}}
Expand All @@ -21,7 +21,7 @@ description: >
{{% /cardpane %}}


#### Previous updates
### Previous updates

{{% cardpane %}}
{{% card header="Q2 2024" %}}
Expand Down
4 changes: 2 additions & 2 deletions website/go.mod
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
module github.com/sap/cap-operator/website

go 1.23.1
go 1.23.3

require github.com/google/docsy v0.10.0 // indirect
require github.com/google/docsy v0.11.0 // indirect
6 changes: 3 additions & 3 deletions website/go.sum
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
github.com/FortAwesome/Font-Awesome v0.0.0-20240402185447-c0f460dca7f7/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
github.com/google/docsy v0.10.0 h1:6tMDacPwAyRWNCfvsn/9qGOZDQ8b0aRzjRZvnZPY5dg=
github.com/google/docsy v0.10.0/go.mod h1:c0nIAqmRTOuJ01F85U/wJPQtc3Zj9N58Kea9bOT2AJc=
github.com/FortAwesome/Font-Awesome v0.0.0-20240716171331-37eff7fa00de/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
github.com/google/docsy v0.11.0 h1:QnV40cc28QwS++kP9qINtrIv4hlASruhC/K3FqkHAmM=
github.com/google/docsy v0.11.0/go.mod h1:hGGW0OjNuG5ZbH5JRtALY3yvN8ybbEP/v2iaK4bwOUI=
github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
Loading

0 comments on commit 4b49664

Please sign in to comment.