Skip to content

Commit db76de5

Browse files
committed
[THREESCALE-7921] Update docs
1 parent 56e6b45 commit db76de5

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

doc/apicast-crd-reference.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
| `httpsPort` | int | No | 8443 only when `httpsCertificateSecretRef` is provided | Controls on which port APIcast should start listening for HTTPS connections. Do not use `8080` as HTTPS port (see [docs](https://github.com/3scale/APIcast/blob/master/doc/parameters.md#apicast_https_port)) |
3737
| `httpsVerifyDepth` | int | No | N/A | Defines the maximum length of the client certificate chain. (see [docs](https://github.com/3scale/APIcast/blob/master/doc/parameters.md#apicast_https_verify_depth)) |
3838
| `httpsCertificateSecretRef` | LocalObjectReference | No | APIcast has a default certificate used when `httpsPort` is provided | References secret containing the X.509 certificate in the PEM format and the X.509 certificate secret key |
39+
| `caCertificateSecretRef` | LocalObjectReference | No | N/A | References secret containing the X.509 CA certificate |
3940
| `workers` | integer | No | Automatically computed. Check [apicast doc](https://github.com/3scale/APIcast/blob/master/doc/parameters.md#apicast_workers) for further info. | Defines the number of worker processes |
4041
| `timezone` | string | No | N/A | The local timezone of the APIcast deployment pods. Its value must be a compatible value with the tz database | Defines the number of worker processes |
4142
| `customPolicies` | [][CustomPolicySpec](#CustomPolicySpec) | No | N/A | List of custom policies |

doc/operator-user-guide.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -311,6 +311,37 @@ $ echo quit | openssl s_client -showcerts -connect 127.0.0.1:8443 2>/dev/null |
311311
312312
The downloaded certificate should match provided certificate.
313313
314+
#### Override default CA certificate at pod level
315+
You can override the default CA certificate used by APIcast pod with `caCertificateSecretRef` field.
316+
317+
Steps to override CA certificate at pod level:
318+
319+
1.- Genrate CA certificate
320+
```
321+
openssl genrsa -out rootCA.key 2048
322+
openssl req -batch -new -x509 -nodes -key rootCA.key -sha256 -days 1024 -out rootCA.pem
323+
```
324+
325+
2.- Create the certificate secret
326+
```
327+
kubectl create secret generic cacert --namespace=apicast-test --from-file=ca-bundle.crt=rootCA.pem
328+
```
329+
330+
3.- Reference the certificate secret in APIcast CR
331+
332+
```
333+
apiVersion: apps.3scale.net/v1alpha1
334+
kind: APIcast
335+
metadata:
336+
name: apicast1
337+
spec:
338+
...
339+
caCertificateSecretRef:
340+
name: cacert
341+
```
342+
343+
See [APIcast CRD reference](apicast-crd-reference.md)
344+
314345
### Reconciliation
315346
After an APIcast self-managed gateway solution has been installed, APIcast
316347
operator enables updating a given set of parameters from the custom resource

0 commit comments

Comments
 (0)