Skip to content
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

Update Tyk Operator CRD for version operator-release-v0.18.8-rc-test #334

Merged
merged 9 commits into from
Oct 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,15 @@ spec:
value: {{ .Values.bootstrap.dashboard | quote }}
- name: TYK_K8SBOOTSTRAP_OPERATORKUBERNETESSECRETNAME
value: {{ .Values.bootstrap.operatorSecret }}
- name: TYK_K8SBOOTSTRAP_OPERATORLICENSEKEY
{{ if .Values.global.secrets.useSecretName }}
valueFrom:
secretKeyRef:
key: OperatorLicense
name: {{ .Values.global.secrets.useSecretName }}
{{ else }}
value: {{ .Values.global.license.operator | quote }}
{{ end }}
- name: TYK_K8SBOOTSTRAP_BOOTSTRAPPORTAL
value: {{ .Values.bootstrap.portal | quote }}
{{- if .Values.bootstrap.org.hybrid.enabled }}
Expand Down
14 changes: 11 additions & 3 deletions components/tyk-bootstrap/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ global:
license:
# The license key needed for the Tyk Dashboard.
dashboard: ""
# The license key needed for Tyk Operator.
#
# NOTE: If you do not want to store license as a plain text in the file, you can use a Kubernetes secret
# that stores the operator license. Please see `.global.secrets.useSecretName`.
operator: ""
adminUser:
# If you don't want to store plaintext secrets for admin user in the Helm value file and would
# rather provide the k8s Secret externally please populate the value below
Expand Down Expand Up @@ -48,7 +53,10 @@ global:
# If you don't want to store plaintext secrets in the Helm value file and would
# rather provide the k8s Secret externally please populate the value below
# You can set following fields in the secret
# APISecret - Sets node secret in both dashboard and tyk config
# AdminSecret - Admin user secret key
# DashLicense - Tyk Dashboard license key
# OperatorLicense - Tyk Operator license key
useSecretName: ""
devPortal: tyk-dev-portal-conf

Expand Down Expand Up @@ -81,7 +89,7 @@ bootstrap:
# repository specifies image repository of pre-install job.
repository: tykio/tyk-k8s-bootstrap-pre-install
# tag specifies image tag of pre-install job.
tag: v2.1.2
tag: v2.2.0

# extraEnvs is used to set extra environment variables to pre-install job.
# - name: TYK_K8SBOOTSTRAP_TYK_DASHBOARDLICENSE
Expand All @@ -95,7 +103,7 @@ bootstrap:
# repository specifies image repository of post-install job.
repository: tykio/tyk-k8s-bootstrap-post
# tag specifies image tag of post-install job.
tag: v2.1.2
tag: v2.2.0

# extraEnvs is used to set extra environment variables to post-install job.
# - name: TYK_K8SBOOTSTRAP_TYK_ADMIN_FIRSTNAME
Expand All @@ -109,7 +117,7 @@ bootstrap:
# repository specifies image repository of pre-delete job.
repository: tykio/tyk-k8s-bootstrap-pre-delete
# tag specifies image tag of pre-delete job.
tag: v2.1.2
tag: v2.2.0

# extraEnvs is used to set extra environment variables to pre-delete job.
# - name: TYK_K8SBOOTSTRAP_OPERATORKUBERNETESSECRETNAME
Expand Down
5 changes: 5 additions & 0 deletions components/tyk-operator/Chart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
apiVersion: v2
name: tyk-operator
description: A Helm chart to install the tyk-operator
type: application
version: 1.0.0 # version of the chart
43 changes: 43 additions & 0 deletions components/tyk-operator/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## Tyk Operator

Tyk Operator brings Full Lifecycle API Management capabilities to Kubernetes. Configure Ingress, APIs, Security Policies, Authentication, Authorization, Mediation and more - all using GitOps best practices with Custom Resources and Kubernetes-native primitives.

### Usage

```bash
helm repo add tyk-charts https://helm.tyk.io/public/helm/charts/
helm repo update
```

### Prerequisites

Before installing the Operator make sure you follow this guide and complete all
steps from it, otherwise the Operator won't function properly: https://github.com/TykTechnologies/tyk-operator/blob/master/docs/installation/installation.md#tyk-operator-installation

**_NOTE_:** cert-manager is required as described [here](https://tyk.io/docs/tyk-stack/tyk-operator/installing-tyk-operator/#step-2-installing-cert-manager).
If you haven't installed `cert-manager` yet, you can install it as follows:
```
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.8.0/cert-manager.yaml
```

### Installation
If you have fully functioning & bootstrapped Tyk Installation and cert-manager,
you can install Tyk Operator as follows:

```bash
helm install tyk-operator tyk-charts/tyk-operator
```

By default it will install latest stable release of operator.

You can install any other version by
1. Setting `image.tag` in values.yml or with `--set {image.tag}={VERSION_TAG}` while doing the helm install.
2. Installing CRDs of corresponding version. This is important as operator might not work otherwise. You can do so by running below command.
```
kubectl apply -f https://github.com/TykTechnologies/tyk-charts/releases/download/operator-release-{VERSION_TAG}/crds.yaml
```

Replace `VERSION_TAG` with operator version tag.


> **_NOTE_:** If you want to install `latest` release of operator, replace `VERSION_TAG` with `master` while installing CRDs.
Loading