Skip to content

[TT-9919] add docs for configuring cert-manager and webhooks #6054

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 45 commits into from
Apr 8, 2025
Merged
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
c30b0ad
add docs for configuring cert-manager and webhooks
olamilekan000 Mar 4, 2025
b1c4081
Merge master into TT-9919-allow-disabling-cert-manager
github-actions[bot] Mar 12, 2025
c02ba32
Merge master into TT-9919-allow-disabling-cert-manager
github-actions[bot] Mar 12, 2025
4aa5424
Merge master into TT-9919-allow-disabling-cert-manager
github-actions[bot] Mar 12, 2025
a82bbd1
Merge master into TT-9919-allow-disabling-cert-manager
github-actions[bot] Mar 12, 2025
26290dc
Merge master into TT-9919-allow-disabling-cert-manager
github-actions[bot] Mar 13, 2025
c1c6d84
Merge master into TT-9919-allow-disabling-cert-manager
github-actions[bot] Mar 13, 2025
2811c5d
Merge master into TT-9919-allow-disabling-cert-manager
github-actions[bot] Mar 13, 2025
03b1b12
Merge master into TT-9919-allow-disabling-cert-manager
github-actions[bot] Mar 14, 2025
8641809
Merge master into TT-9919-allow-disabling-cert-manager
github-actions[bot] Mar 14, 2025
9581fc4
Merge master into TT-9919-allow-disabling-cert-manager
github-actions[bot] Mar 14, 2025
9e9ce72
Merge master into TT-9919-allow-disabling-cert-manager
buger Mar 17, 2025
26af470
Merge master into TT-9919-allow-disabling-cert-manager
buger Mar 17, 2025
005794f
Merge master into TT-9919-allow-disabling-cert-manager
buger Mar 18, 2025
ffcc22a
Merge master into TT-9919-allow-disabling-cert-manager
buger Mar 18, 2025
d43f1fa
Merge master into TT-9919-allow-disabling-cert-manager
buger Mar 18, 2025
f16b6d0
Merge master into TT-9919-allow-disabling-cert-manager
buger Mar 19, 2025
508f109
Merge master into TT-9919-allow-disabling-cert-manager
buger Mar 20, 2025
c148572
Merge master into TT-9919-allow-disabling-cert-manager
buger Mar 20, 2025
1a4d02f
Merge master into TT-9919-allow-disabling-cert-manager
buger Mar 20, 2025
68ce347
Merge master into TT-9919-allow-disabling-cert-manager
buger Mar 28, 2025
c99c10b
Merge master into TT-9919-allow-disabling-cert-manager
buger Mar 28, 2025
debbffd
Merge master into TT-9919-allow-disabling-cert-manager
buger Mar 28, 2025
14f9d50
Merge master into TT-9919-allow-disabling-cert-manager
buger Mar 28, 2025
9fcfa3b
Merge master into TT-9919-allow-disabling-cert-manager
buger Mar 28, 2025
c8a0dc8
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 1, 2025
e7a1f55
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 1, 2025
60429d5
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 1, 2025
dd3e39e
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 1, 2025
1e4e51a
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 1, 2025
d0c607d
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 2, 2025
e2fcfcc
Update operator.md
komalsukhani Apr 2, 2025
24b03ec
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 2, 2025
6fe0538
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 3, 2025
97df4eb
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 3, 2025
879d47a
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 3, 2025
c395494
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 3, 2025
d8640d9
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 4, 2025
7540af7
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 4, 2025
6950d9c
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 8, 2025
7ef9c12
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 8, 2025
bfff1ee
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 8, 2025
a4224eb
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 8, 2025
5147279
Fixes
sharadregoti Apr 8, 2025
ef162f1
Merge master into TT-9919-allow-disabling-cert-manager
buger Apr 8, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions tyk-docs/content/api-management/automations/operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,8 @@ maintaining a single source of truth for your API configurations.
Tyk Operator uses cert-manager to provision certificates for the webhook server. If you don't have cert-manager
installed, you can follow this command to install it:

Alternatively, you have the option to manually handle TLS certificates by disabling the `cert-manager` requirement. For more details, please refer to this [configuration]({{< ref "#webhook-configuration" >}}).

```console
$ kubectl apply --validate=false -f https://github.com/jetstack/cert-manager/releases/download/v1.8.0/cert-manager.yaml
```
Expand Down Expand Up @@ -429,6 +431,10 @@ in `tyk-operator-system` namespace.

**Helm configurations**

{{< note warning >}} **Note**
Starting from Tyk Operator v1.2.0, `webhookPort` is deprecated in favor of `webhooks.port`.
{{< /note >}}

| Key | Type | Default |
| ------------------------------------------- | ------ | -------------------------------------- |
| envFrom[0].secretRef.name | string | `"tyk-operator-conf"` |
Expand Down Expand Up @@ -461,6 +467,12 @@ in `tyk-operator-system` namespace.
| resources | object | `{}` |
| serviceMonitor | bool | `false` |
| webhookPort | int | `9443` |
| webhooks.enabled | bool | `true` |
| webhooks.port | int | `9443` |
| webhooks.annotations | object | `{}` |
| webhooks.tls.useCertManager | bool | `true` |
| webhooks.tls.secretName | string | `webhook-server-cert` |
| webhooks.tls.certificatesMountPath | string | `/tmp/k8s-webhook-server/serving-certs`|

### Upgrading Tyk Operator

Expand Down Expand Up @@ -513,6 +525,28 @@ To uninstall Tyk Operator, you need to run the following command:
$ helm delete tyk-operator -n tyk-operator-system
```

### Webhook Configuration

Starting from Operator v1.2.0 release, [Kubernetes Webhooks](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers) can now be configured using the Helm chart by specifying the necessary settings in the values.yaml file of the operator.
Since webhooks are enabled by default, there will be no impact to existing users.

```
webhooks:
enabled: true
port: 9443
annotations: {}
tls:
useCertManager: true
secretName: webhook-server-cert
certificatesMountPath: "/tmp/k8s-webhook-server/serving-certs"
```
- `enabled`: Enables or disables webhooks.
- `port`: Specifies the port for webhook communication.
- `annotations`: Allows adding custom annotations.
- `tls.useCertManager`: If true, Cert-Manager will handle TLS certificates.
- `tls.secretName`: The name of the Kubernetes Secret storing the TLS certificate.
- `tls.certificatesMountPath`: Path where the webhook server mounts its certificates.

## Set Up Tyk OAS API
Setting up OpenAPI Specification (OAS) APIs with Tyk involves preparing an OAS-compliant API definition and configuring it within your Kubernetes cluster using Tyk Operator. This process allows you to streamline API management by storing the OAS definition in a Kubernetes ConfigMap and linking it to Tyk Gateway through a TykOasApiDefinition resource.

Expand Down
Loading