From 2d1b510e6c19367e7fb93bb63be1715cd0ef17eb Mon Sep 17 00:00:00 2001 From: Pranay Sanghvi Date: Mon, 9 Mar 2026 18:45:47 +0530 Subject: [PATCH 1/2] Docs: Add instructions for installing Epinio in a custom namespace --- docs/installation/install_epinio.md | 12 ++++++++++++ docs/installation/uninstall_epinio.md | 6 ++++++ 2 files changed, 18 insertions(+) diff --git a/docs/installation/install_epinio.md b/docs/installation/install_epinio.md index 7d33f1e66f..475f25a53b 100644 --- a/docs/installation/install_epinio.md +++ b/docs/installation/install_epinio.md @@ -121,6 +121,18 @@ helm repo update helm upgrade --install epinio epinio/epinio --namespace epinio --create-namespace \ --set global.domain=myepiniodomain.org ``` + +### Install Epinio in a custom namespace + +You can install Epinio in a custom namespace by changing the `--namespace` flag. + +```bash +helm repo add epinio https://epinio.github.io/helm-charts +helm repo update +helm upgrade --install epinio epinio/epinio --namespace my-custom-namespace --create-namespace \ + --set global.domain=myepiniodomain.org +``` + Or you can install using "Let's Encrypt" certificates. To generate trusted TLS certificates with "Let's Encrypt" for your public domain set `.Values.global.tlsIssuer` to `letsencrypt-production` and the value for the `.Values.global.tlsIssuerEmail` key to your e-mail address. Then: diff --git a/docs/installation/uninstall_epinio.md b/docs/installation/uninstall_epinio.md index 257b2254af..02832794e7 100644 --- a/docs/installation/uninstall_epinio.md +++ b/docs/installation/uninstall_epinio.md @@ -21,3 +21,9 @@ If you installed Epinio in a namespace `epinio`, you uninstall with the command: ```bash $ helm uninstall -n epinio epinio ``` + +If you installed Epinio in a custom namespace, replace `epinio` with your custom namespace: + +```bash +$ helm uninstall -n epinio +``` From 918f94059d3d517e651f416c99f8260ff30764b3 Mon Sep 17 00:00:00 2001 From: Pranay Sanghvi Date: Mon, 9 Mar 2026 19:29:12 +0530 Subject: [PATCH 2/2] Update contribute.md --- docs/howtos/contribute.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/howtos/contribute.md b/docs/howtos/contribute.md index ec9d7a9456..3514025dd4 100644 --- a/docs/howtos/contribute.md +++ b/docs/howtos/contribute.md @@ -96,6 +96,28 @@ If not, the Developer Certificate of Origin (DCO) check rejects the pull request ::: +## Development Environment + +For detailed instructions on setting up a local development environment, please refer to the [Development Guidelines](https://github.com/epinio/epinio/blob/main/docs/howtos/development.md) in the Epinio repository. + +### Updating the running Epinio server + +Every time a change is made in the Epinio source code, the binary running inside +the epinio-server Pod has to be replaced with a freshly compiled one. This can +be achieved by running the following command: + +```bash +make && make patch-epinio-deployment +``` + +If Epinio is installed in a custom namespace, you need to specify it using the `EPINIO_NAMESPACE` environment variable: + +```bash +EPINIO_NAMESPACE=my-namespace make && EPINIO_NAMESPACE=my-namespace make patch-epinio-deployment +``` + +This first compiles a new binary locally and then replaces the one running inside the Pod with it. + ## Pull requests Pull requests for a code change should reference the issue they're for.