Skip to content

Commit b8653fc

Browse files
authored
Merge branch '1.3.0' into 1.3.0-roles-and-rolebindings
2 parents 4cfbdf1 + 65e13ca commit b8653fc

File tree

5 files changed

+53
-19
lines changed

5 files changed

+53
-19
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
apiVersion: cert-manager.io/v1
2+
kind: Issuer
3+
metadata:
4+
name: custom-issuer
5+
namespace: apk
6+
spec:
7+
ca:
8+
secretName: apk-root-certificate
92.7 KB
Loading

en/docs/setup/cert-manager.md

+1
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@ Now, install APK using Helm with the modified values.yaml file.
107107

108108
## 7. Verify the Certificate Status
109109

110+
110111
Once APK is installed, check the certificates by running:
111112
=== "Command"
112113
```

en/docs/setup/prerequisites.md

+11
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,17 @@ We recommend the following minimum resource requirements for running WSO2 Kubern
4545
| Storage | 15 GB |
4646

4747

48+
**Minimum requirements per Component:**
49+
50+
| Component | CPU Requests (m) | Memory Requests (Mi) |
51+
| --------------------------------------- | ---------------- | -------------------- |
52+
| **Adapter** | 50m | 64Mi |
53+
| **Common Controller** | 50m | 64Mi |
54+
| **Config Deployer Service** | 200m | 512Mi |
55+
| **Gateway Runtime (Enforcer + Router)** | 50m | 128Mi |
56+
| **IdP Domain Service** | 200m | 512Mi |
57+
| **IdP UI** | 50m | 64Mi |
58+
| **Rate Limiter** | 50m | 64Mi |
4859

4960
**Minimum requirements for Kubernetes Gateway Data Plane with APIM Control Plane:**
5061

en/docs/setup/production-deployment-guideline.md

+33-19
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,14 @@ For a production environment, it is recommended to use CA-validated public certi
4848
| Gateway server | `<helm-installation-name>-gateway-service.<namespace-name>.svc`, `<helm-installation-name>-gateway-service.<namespace-name>.svc.cluster.local` |
4949
| Ratelimitter server | `<helm-installation-name>-ratelimiter-service.<namespace-name>.svc`, `<helm-installation-name>-ratelimiter-service.<namespace-name>.svc.cluster.local` |
5050

51-
### 1. Use cert manager
51+
### 1: Use cert-manager
5252

53-
By default, Kubernetes Gateway installs cert manager in your cluster and employs a SelfSigned issuer for certificate validations. To utilize cert manager for handling the certificates, you will need to create [Issuers](https://cert-manager.io/docs/configuration/). Choose the type of Issuer you are going to use for listeners and servers, and create the Issuers in accordance with the [cert-manager documentation](https://cert-manager.io/docs/configuration/) document. You will need to create two issuers: one for listeners and one for servers.
53+
!!! note
54+
This will install cert-manager **within the namespace APK is installed in**. If you already have a cert-manager installation, or you wish to install cert-manager in a different namespace, follow the steps provided in
55+
56+
By default, the Kubernetes Gateway helm installation installs-cert manager in your cluster and employs a SelfSigned ClusterIssuer for certificate validations. To utilize cert manager for handling the certificates, you will need to create **Issuers**.
57+
58+
Choose the type of Issuer you are going to use for listeners and servers, and create them in accordance with the <a href="https://cert-manager.io/docs/configuration/" target="_blank">official cert-manager documentation</a>. You will need to create two Issuers: one for listeners and one for servers.
5459

5560
Once created, update the values.yaml configuration as follows. This configuration is to be placed at the same indentation level as the `wso2` configuration in the values.yaml file.
5661

@@ -60,36 +65,45 @@ wso2:
6065
certmanager:
6166
listeners:
6267
issuerName: "<issuer-name-created-for-listeners>"
63-
issuerKind: "ClusterIssuer" # or "Issuer" Refer to cert-manager's issuer doc
64-
servers:
68+
issuerKind: "ClusterIssuer" # or "Issuer"
69+
servers:
6570
issuerName: "<issuer-name-created-for-servers>"
66-
issuerKind: "ClusterIssuer" # or "Issuer" Refer to cert-manager's issuer doc
71+
issuerKind: "ClusterIssuer" # or "Issuer"
6772
```
6873
69-
### 2. Use the certificate files
74+
### 2: Create the secrets
7075
71-
<b>Prerequisites</b>
76+
#### Prerequisites
7277
73-
For all the components(Listeners and servers) prepare the following required files.
78+
##### 1. Generate the necessary certificate information
79+
For all the components (listeners and servers), prepare the following information.
7480
75-
1. TLS certificate verified by a Ceriticate Authority (tls.crt)
76-
2. Private key associated with the TLS certificate(tls.key)
77-
3. Certificate Authority's (CA) root certificate(ca.crt)
81+
1. TLS certificate verified by a Certificate Authority (tls.crt)
82+
2. Private key associated with the TLS certificate (tls.key)
83+
3. Certificate Authority's (CA) root certificate (ca.crt)
7884
85+
##### 2. Create the secrets
7986
For each component create a secret in the same namespace as Kubernetes Gateway is deployed with the following key-value pairs:
8087
8188
- tls.crt - Base64 encoded value of tls.crt file
8289
- tls.key - Base64 encoded value of tls.key file
8390
- ca.crt - Base64 encoded value of ca.crt file
8491
85-
You can use the following command to create the secret from the files
92+
Apply them in the same namespace as the APK installation.
93+
94+
You can use the following command to create the secret from the files.
95+
=== "Command"
96+
```
97+
kubectl create secret generic gateway-listener-secret --from-file=./tls.crt --from-file=tls.key=./tls.key --from-file=ca.crt=./ca.crt -n apk
98+
```
99+
=== "Format"
100+
```
101+
kubectl create secret generic <SECRET_NAME> --from-file=tls.crt=<path/to/tls.crt> --from-file=tls.key=<path/to/tls.key> --from-file=ca.crt=<path/to/ca.crt> -n <NAMESPACE>
102+
```
86103

87-
```
88-
kubectl create secret generic <SECRET_NAME> --from-file=tls.crt=path/to/tls.crt --from-file=tls.key=path/to/tls.key --from-file=ca.crt=path/to/ca.crt -n <NAMESPACE>
89-
```
104+
You will need the names of the secrets to add to the values.yaml file.
90105

91106
- To update the gateway listener certificates, update the following values.yaml config
92-
93107
```yaml
94108
wso2:
95109
...
@@ -130,11 +144,11 @@ Servers and their `configs` location in the value.yaml are listed below.
130144
| Servers | Config location |
131145
| ------------------------ | ---------------------------------------------------------- |
132146
| Adapter server | wso2.apk.dp.adapter.configs.tls |
133-
| Common controller server | wso2.apk.dp.configdeployer.deployment.configs.tls |
134-
| Config deployer server | wso2.apk.dp.configdeployer.deployment.configs.tls |
147+
| Common Controller server | wso2.apk.dp.configdeployer.deployment.configs.tls |
148+
| Config Deployer server | wso2.apk.dp.configdeployer.deployment.configs.tls |
135149
| Enforcer server | wso2.apk.dp.gatewayRuntime.deployment.enforcer.configs.tls |
136150
| Gateway server | wso2.apk.dp.gatewayRuntime.deployment.router.configs.tls |
137-
| Ratelimitter server | wso2.apk.dp.ratelimiter.deployment.configs.tls |
151+
| Ratelimiter server | wso2.apk.dp.ratelimiter.deployment.configs.tls |
138152

139153
## Remove default IdP
140154

0 commit comments

Comments
 (0)