From f29fe22d3dd00b1bb17523673bdd863fd5d533ab Mon Sep 17 00:00:00 2001 From: Philipp Heckel Date: Thu, 17 Nov 2022 20:57:01 -0500 Subject: [PATCH] Fine tuning --- docs/install.md | 21 +++++++++++---------- docs/releases.md | 1 + 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/install.md b/docs/install.md index 8a062bfc..77c9aefd 100644 --- a/docs/install.md +++ b/docs/install.md @@ -443,19 +443,20 @@ Configuration is relatively straightforward. As an example, a minimal configurat ## Kustomize -`ntfy` can be deployed in Kubernetes cluster with [Kustomize](https://github.com/kubernetes-sigs/kustomize) - tool used to customize Kubernetes objects using kustomization file. +ntfy can be deployed in a Kubernetes cluster with [Kustomize](https://github.com/kubernetes-sigs/kustomize), a tool used +to customize Kubernetes objects using a `kustomization.yaml` file. 1. Create new folder - `ntfy` 2. Add all files listed below - 1. kustomization.yaml - stores all configmaps and resources used in deployment - 2. ntfy-deployment.yam - define deployment type and it's parameters- - 3. ntfy-pvc.yaml - describes how [persistent volume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) will be created - 4. ntfy-svc.yaml - expose application to the internal kubernetes network - 5. ntfy-ingress.yaml - expose service to outside network using [Ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/) - 6. server.yaml - simple server configuration -4. Replace **TESTNAMESPACE** within kustomization.yaml with designated namespace -5. Replace **ntfy.test** within ntfy-ingress.yaml with desired DNS name -6. Apply configuration to cluster set in current context: + 1. `kustomization.yaml` - stores all configmaps and resources used in a deployment + 2. `ntfy-deployment.yaml` - define deployment type and its parameters + 3. `ntfy-pvc.yaml` - describes how [persistent volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) will be created + 4. `ntfy-svc.yaml` - expose application to the internal kubernetes network + 5. `ntfy-ingress.yaml` - expose service to outside the network using [ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/) + 6. `server.yaml` - simple server configuration +3. Replace **TESTNAMESPACE** within `kustomization.yaml` with designated namespace +4. Replace **ntfy.test** within `ntfy-ingress.yaml` with desired DNS name +5. Apply configuration to cluster set in current context: ```bash kubectl apply -k /ntfy diff --git a/docs/releases.md b/docs/releases.md index ceb3659a..90be26fc 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -28,6 +28,7 @@ requests. * GitHub Actions example ([#492](https://github.com/binwiederhier/ntfy/pull/492), thanks to [@ksurl](https://github.com/ksurl)) * UnifiedPush ACL clarification ([#497](https://github.com/binwiederhier/ntfy/issues/497), thanks to [@bt90](https://github.com/bt90)) +* Install instructions for Kustomize ([#463](https://github.com/binwiederhier/ntfy/pull/463), thanks to [@l-maciej](https://github.com/l-maciej)) **Other things:**