Skip to content

Commit

Permalink
more detailed installation guide and examples
Browse files Browse the repository at this point in the history
rh-pre-commit.version: 2.2.0
rh-pre-commit.check-secrets: ENABLED
  • Loading branch information
maleck13 committed Dec 10, 2024
1 parent 19276ee commit 77c9151
Show file tree
Hide file tree
Showing 10 changed files with 350 additions and 58 deletions.
301 changes: 255 additions & 46 deletions config/install/README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion config/install/configure/redis-storage/kustomization.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ secretGenerator:
namespace: kuadrant-system
envs:
- redis-credentials.env
type: 'kuadrant.io/aws'
type: 'kuadrant.io/redis'
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# If using this you will need to rename the file and remove the .sample suffix and remove this comment

KUADRANT_AWS_ACCESS_KEY_ID=xxx
KUADRANT_AWS_SECRET_ACCESS_KEY=xxx
KUADRANT_AWS_REGION=eu-west-1
20 changes: 20 additions & 0 deletions config/install/full-example-aws/configure/cluster-issuer.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# example lets-encrpyt cluster issuer that will work with the credentials we will add

Check failure on line 1 in config/install/full-example-aws/configure/cluster-issuer.yaml

View workflow job for this annotation

GitHub Actions / github.com/client9/misspell

[github.com/client9/misspell] config/install/full-example-aws/configure/cluster-issuer.yaml#L1

"encrpyt" is a misspelling of "encrypt"
Raw output
config/install/full-example-aws/configure/cluster-issuer.yaml:1:15: "encrpyt" is a misspelling of "encrypt"
apiVersion: cert-manager.io/v1
kind: ClusterIssuer
metadata:
name: lets-encrypt-aws
spec:
acme:
privateKeySecretRef:
name: le-secret
server: https://acme-v02.api.letsencrypt.org/directory
solvers:
- dns01:
route53:
accessKeyIDSecretRef:
key: AWS_ACCESS_KEY_ID
name: aws-provider-credentials #notice this matches the name of the secret we created.
region: us-east-1 #override if needed
secretAccessKeySecretRef:
key: AWS_SECRET_ACCESS_KEY
name: aws-provider-credentials
29 changes: 29 additions & 0 deletions config/install/full-example-aws/configure/kustomization.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- https://github.com/Kuadrant/kuadrant-operator//config/install/configure/standard?ref=v1.0.1 #change this version as needed (see https://github.com/Kuadrant/kuadrant-operator/releases)
- cluster-issuer.yaml #(comment if you dont want to use it. The issuer yaml is defined below).
- limitador.yaml

generatorOptions:
disableNameSuffixHash: true
labels:
app.kubernetes.io/part-of: kuadrant
app.kubernetes.io/managed-by: kustomize

secretGenerator:
- name: aws-provider-credentials
namespace: cert-manager # assumes cert-manager namespace exists.
envs:
- aws-credentials.env # notice this matches the .env file above. You will need to setup this file locally
type: 'kuadrant.io/aws'
- name: aws-provider-credentials
namespace: gateway-system # this is the namespace where your gateway will be provisioned
envs:
- aws-credentials.env #notice this matches the .env file above. you need to set up this file locally first.
type: 'kuadrant.io/aws'
- name: redis-credentials
namespace: kuadrant-system
envs:
- redis-credentials.env
type: 'kuadrant.io/redis'
11 changes: 11 additions & 0 deletions config/install/full-example-aws/configure/limitador.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
apiVersion: limitador.kuadrant.io/v1alpha1
kind: Limitador
metadata:
name: limitador
namespace: kuadrant-system
spec:
storage:
redis:
configSecretRef:
name: redis-credentials

Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# If using this you will need to rename the file and remove the .sample suffix and remove this comment

URL=redis://xxxx
17 changes: 17 additions & 0 deletions config/install/full-example-aws/install/kustomization.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- https://github.com/Kuadrant/kuadrant-operator//config/install/standard?ref=v1.0.1 #change this version as needed (see https://github.com/Kuadrant/kuadrant-operator/releases)
#- https://github.com/Kuadrant/kuadrant-operator//config/install/openshift?ref=v1.0.1 #use if targeting an OCP cluster. Change this version as needed (see https://github.com/Kuadrant/kuadrant-operator/releases).

patches: # remove the subscription patch if you are installing a development version. It will then use the "preview" channel
- patch: |-
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: kuadrant
spec:
source: kuadrant-operator-catalog
sourceNamespace: kuadrant-system
name: kuadrant-operator
channel: 'stable' #set to preview if not using a release (for example if using main)
9 changes: 9 additions & 0 deletions config/install/no-gateway-provider/kustomization.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

# note by default this will install the version of kuadrant you checkout from v1 onwards
# if you want to install a different released version you can use the patch options below.
# If you want to install the latest development tag, remove the subscription patch
resources:
- https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.1.0/standard-install.yaml
- ../../deploy/olm
11 changes: 0 additions & 11 deletions config/install/standard/kustomization.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,3 @@ resources:
- https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.1.0/standard-install.yaml
- sail-operator.yaml
- ../../deploy/olm
patches: # remove the subscription patch if you are installing a development version. It will then use the "preview" channel
- patch: |-
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: kuadrant
spec:
source: kuadrant-operator-catalog
sourceNamespace: kuadrant-system
name: kuadrant-operator
channel: 'stable'

0 comments on commit 77c9151

Please sign in to comment.