Skip to content

Commit 5663f92

Browse files
authored
Merge pull request #453 from epinio/docs/kubed-reflector
Docs/kubed reflector
2 parents 59f75bd + 85ef605 commit 5663f92

File tree

3 files changed

+20
-34
lines changed

3 files changed

+20
-34
lines changed

docs/explanations/advanced.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,11 @@ The Epinio API server runs on the cluster.
7878
It's reached using Kubernetes resources like
7979
Deployments, Services, Ingresses and Secrets.
8080

81-
### Kubed
81+
### Reflector
8282

83-
[Kubed documentation](https://github.com/kubeops/kubed)
83+
[Relector documentation](https://github.com/emberstack/kubernetes-reflector)
8484

85-
Epinio installs Kubed to keep secrets, needed in more than one namespace, synchronized.
86-
For example, the image pull secret is needed in every application namespace
87-
so that Kubernetes can pull the built application images from the [Container Registry](#container-registry).
88-
89-
Kubed makes sure that if the source secret changes, the copies change too.
85+
Reflector is a Kubernetes addon designed to monitor changes to resources (secrets and configmaps) and reflect changes to mirror resources in the same or other namespaces.
9086

9187
### Minio
9288

docs/howtos/customization/setup_routing_secrets.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -55,22 +55,6 @@ Use them only where absolutely necessary with everything else keeping to the aut
5555
The secret is used whenever a requested application route matches the wildcard pattern.
5656
This reduces the number of Secrets needing creation.
5757

58-
1. You can automate distribution of routing secrets by using a component like Kubed.
59-
Kubed can automatically copy secrets between namespaces based on annotations.
60-
Kubed is a component of Epinio so is available.
61-
As an example,
62-
63-
1. Place a new routing secret `RS` into the namespace `epinio`.
64-
65-
1. Annotate the secret with
66-
67-
`kubed.appscode.com/sync="app.kubernetes.io/component=epinio-namespace"`
68-
69-
1. Kubed now distributes `RS` to all namespaces which have the label `app.kubernetes.io/component=epinio-namespace`.
70-
These are all the namespaces under Epinio's control.
71-
72-
For a more limited distribution it's possible to add custom labels to the
73-
desired namespaces and add matching annotations on the relevant Secrets.
74-
75-
The distribution automatically includes all new namespaces
76-
matching whatever criteria are in place.
58+
1. You can automate distribution of routing secrets by using a component like [Reflector](https://github.com/emberstack/kubernetes-reflector).
59+
Reflector can automatically copy secrets between namespaces based on annotations.
60+
Reflector is a component of Epinio so is available.

docs/installation/install_epinio.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ keywords: [epinio, kubernetes, k8s, installation, install]
99
## Introduction
1010

1111
Epinio is installed from a single Helm chart.
12-
This also installs [`Kubed`](#kubed), [`MinIO`](#s3-storage), [`Dex`](#dex) and a [container registry](#container-registry) in your Kubernetes cluster.
12+
This also installs Reflector, [`MinIO`](#s3-storage), [`Dex`](#dex) and a [container registry](#container-registry) in your Kubernetes cluster.
1313
You can disable the installation of these additional "sub" charts by changing the settings as described in their sections below.
1414

1515
## Prerequisites
@@ -230,12 +230,6 @@ There exists examples within the `values.yaml` file under the `server.stagingWor
230230
231231
The configurations under `server.stagingWorkloads` gets mapped to the build script ConfigMaps which is then processed by the Epinio Server when builds are kicked off. These specifications are supplied to the newly created staging jobs.
232232
233-
### Kubed
234-
235-
Kubed is installed as a subchart when `.Values.kubed.enabled` is `true` (default).
236-
If you already have `kubed`, you can skip installation by setting
237-
the helm value `.Values.kubed.enabled` to `false`.
238-
239233
### S3 storage
240234
241235
Epinio uses an S3 compatible storage to store the application source code.
@@ -283,8 +277,20 @@ to point to the desired container registry.
283277
284278
### Breaking Changes & Migrations
285279
280+
#### 1.13.7 to 1.13.8
281+
Epinio **1.13.8** switches from using kubed to use [reflector](https://github.com/emberstack/kubernetes-reflector) for syncing ConfigMaps and Secrets across namespaces. This change occured due to kubed being deprecated and unmaintained.
282+
283+
If you are upgrading from **1.13.7** or earlier to **1.13.8** or later, you must manually uninstall kubed from your cluster after the upgrade is complete.
284+
285+
You can view the changes made in the following files:
286+
- [registry-secret.yaml](https://github.com/epinio/helm-charts/blob/main/chart/epinio/templates/registry-secret.yaml)
287+
- [certificate.yaml](https://github.com/epinio/helm-charts/blob/main/chart/epinio/templates/certificate.yaml)
288+
- [values.yaml](https://github.com/epinio/helm-charts/blob/main/chart/epinio/values.yaml)
289+
290+
By default the all of the namespaces are allowed but the reflector can be customized based on your deployment style. If you were not customizing kubed previously, no action is needed other than uninstalling kubed.
291+
286292
#### 1.12 to 1.13
287293
288294
Epinio 1.13 rehomes configurations for the staging workloads to a more Kubernetes-standardized format that supports a larger variety of configs. These are no longer configured via ENV variables on the Epinio Server or through CLI flags but rather read from an in-cluster ConfigMap at staging time.
289295
290-
Documentation has been udpated for both the [Epinio Server](https://github.com/epinio/epinio?tab=readme-ov-file#112-to-113) and the [Epinio Helm Chart](https://github.com/epinio/helm-charts/tree/main/chart/epinio#112-to-113). These READMEs go into detail describing the changes to the environment variables, CLI flags, and changes to the `values.yaml` interface. Please refer to these before upgrading to **1.13**.
296+
Documentation has been updated for both the [Epinio Server](https://github.com/epinio/epinio?tab=readme-ov-file#112-to-113) and the [Epinio Helm Chart](https://github.com/epinio/helm-charts/tree/main/chart/epinio#112-to-113). These READMEs go into detail describing the changes to the environment variables, CLI flags, and changes to the `values.yaml` interface. Please refer to these before upgrading to **1.13**.

0 commit comments

Comments
 (0)