Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
171 commits
Select commit Hold shift + click to select a range
c45d7f6
chore: Update Helm chart URL
Feb 5, 2026
37ddace
chore: Update Epinio Version for EP on RD
Feb 5, 2026
7a62e03
chore: Update Helm chart URL
Feb 5, 2026
78f9484
chore: Update Epinio Version for EP on RD
Feb 5, 2026
1bd4872
chore: Update Helm chart URL
Feb 6, 2026
0f091f2
chore: Update Epinio Version for EP on RD
Feb 6, 2026
280ec98
chore: Update Helm chart URL
Feb 6, 2026
b53c6ec
chore: Update Epinio Version for EP on RD
Feb 6, 2026
8fcfecd
chore: Update Helm chart URL
Feb 7, 2026
2fcb7b9
chore: Update Epinio Version for EP on RD
Feb 7, 2026
c828580
chore: Update Epinio Version for EP on RD
Feb 7, 2026
9eae60d
chore: Update Helm chart URL
Feb 7, 2026
81cefd2
chore: Update Epinio Version for EP on RD
Feb 8, 2026
0b661bc
chore: Update Helm chart URL
Feb 8, 2026
b83ebcc
chore: Update Epinio Version for EP on RD
Feb 8, 2026
a8b87c5
chore: Update Helm chart URL
Feb 8, 2026
fdac987
chore: Update Epinio Version for EP on RD
Feb 9, 2026
e3068ca
chore: Update Helm chart URL
Feb 9, 2026
f2f57cf
chore: Update Helm chart URL
Feb 9, 2026
e9fe31d
chore: Update Epinio Version for EP on RD
Feb 9, 2026
72d7ae7
chore: Update Helm chart URL
Feb 10, 2026
4b8fa7c
chore: Update Epinio Version for EP on RD
Feb 10, 2026
855732f
chore: Update Epinio Version for EP on RD
Feb 10, 2026
d7efb8e
chore: Update Helm chart URL
Feb 10, 2026
1d71173
chore: Update Epinio Version for EP on RD
Feb 11, 2026
5444a68
chore: Update Helm chart URL
Feb 11, 2026
0d74c02
chore: Update Helm chart URL
Feb 11, 2026
3e28f44
chore: Update Epinio Version for EP on RD
Feb 11, 2026
9f878f5
chore: Update Epinio Version for EP on RD
Feb 12, 2026
6c8aaaf
chore: Update Helm chart URL
Feb 12, 2026
cb23455
chore: Update Epinio Version for EP on RD
Feb 12, 2026
12132af
chore: Update Helm chart URL
Feb 12, 2026
c5ca1ba
chore: Update Helm chart URL
Feb 13, 2026
4612a2d
chore: Update Epinio Version for EP on RD
Feb 13, 2026
6fa4e35
chore: Update Epinio Version for EP on RD
Feb 13, 2026
38f0ad1
chore: Update Helm chart URL
Feb 13, 2026
69c5a73
chore: Update Epinio Version for EP on RD
Feb 14, 2026
24c9ddb
chore: Update Helm chart URL
Feb 14, 2026
0fad8fb
chore: Update Epinio Version for EP on RD
Feb 14, 2026
70186ca
chore: Update Helm chart URL
Feb 14, 2026
a87f1bf
chore: Update Helm chart URL
Feb 15, 2026
29782dd
chore: Update Epinio Version for EP on RD
Feb 15, 2026
77dc3e3
chore: Update Helm chart URL
Feb 15, 2026
3859b12
chore: Update Epinio Version for EP on RD
Feb 15, 2026
37a6c02
chore: Update Helm chart URL
Feb 16, 2026
46d6b0e
chore: Update Epinio Version for EP on RD
Feb 16, 2026
0399f27
chore: Update Helm chart URL
Feb 16, 2026
f9cc8a5
chore: Update Epinio Version for EP on RD
Feb 16, 2026
c186a5e
chore: Update Epinio Version for EP on RD
Feb 17, 2026
4f31b2f
chore: Update Helm chart URL
Feb 17, 2026
300eb89
chore: Update Epinio Version for EP on RD
Feb 18, 2026
c1461e8
chore: Update Helm chart URL
Feb 18, 2026
3cbcaeb
chore: Update Helm chart URL
Feb 18, 2026
947c56e
chore: Update Epinio Version for EP on RD
Feb 18, 2026
1bd5ae0
chore: Update Epinio Version for EP on RD
Feb 19, 2026
800af83
chore: Update Helm chart URL
Feb 19, 2026
2994ea4
chore: Update Helm chart URL
Feb 19, 2026
8dae85b
chore: Update Epinio Version for EP on RD
Feb 19, 2026
f07d3b0
chore: Update Epinio Version for EP on RD
Feb 20, 2026
f052cfe
chore: Update Helm chart URL
Feb 20, 2026
4a8494a
chore: Update Epinio Version for EP on RD
Feb 20, 2026
1717de7
chore: Update Helm chart URL
Feb 20, 2026
6a11276
chore: Update Helm chart URL
Feb 21, 2026
e78168a
chore: Update Epinio Version for EP on RD
Feb 21, 2026
89e4f8f
chore: Update Helm chart URL
Feb 21, 2026
c977e52
chore: Update Epinio Version for EP on RD
Feb 21, 2026
66df1b1
chore: Update Epinio Version for EP on RD
Feb 22, 2026
621a621
chore: Update Helm chart URL
Feb 22, 2026
96cd478
chore: Update Helm chart URL
Feb 22, 2026
0802e96
chore: Update Epinio Version for EP on RD
Feb 22, 2026
b02f484
chore: Update Epinio Version for EP on RD
Feb 23, 2026
dd4910a
chore: Update Helm chart URL
Feb 23, 2026
eee0481
chore: Update Epinio Version for EP on RD
Feb 23, 2026
0bc96d7
chore: Update Helm chart URL
Feb 23, 2026
93b27b4
chore: Update Helm chart URL
Feb 24, 2026
f30ed66
chore: Update Epinio Version for EP on RD
Feb 24, 2026
7c76aa0
chore: Update Helm chart URL
Feb 24, 2026
b0c4e6a
chore: Update Epinio Version for EP on RD
Feb 24, 2026
6a99885
chore: Update Helm chart URL
Feb 25, 2026
9e6fcde
chore: Update Epinio Version for EP on RD
Feb 25, 2026
f89bcb2
chore: Update Epinio Version for EP on RD
Feb 25, 2026
783f743
chore: Update Helm chart URL
Feb 25, 2026
1e0d86a
chore: Update Epinio Version for EP on RD
Feb 26, 2026
0de14d3
chore: Update Helm chart URL
Feb 26, 2026
2e0d7a8
chore: Update Epinio Version for EP on RD
Feb 26, 2026
7723ce6
chore: Update Helm chart URL
Feb 26, 2026
a496ccb
chore: Update Epinio Version for EP on RD
Feb 27, 2026
8cd7256
chore: Update Helm chart URL
Feb 27, 2026
2102d20
chore: Update Helm chart URL
Feb 27, 2026
bcb13a7
chore: Update Epinio Version for EP on RD
Feb 27, 2026
3f67a70
chore: Update Epinio Version for EP on RD
Feb 28, 2026
a85c5f9
chore: Update Helm chart URL
Feb 28, 2026
8be189f
chore: Update Epinio Version for EP on RD
Feb 28, 2026
07bde73
chore: Update Helm chart URL
Feb 28, 2026
429a09c
chore: Update Helm chart URL
Mar 1, 2026
e967273
chore: Update Epinio Version for EP on RD
Mar 1, 2026
094d498
chore: Update Epinio Version for EP on RD
Mar 1, 2026
94d62b9
chore: Update Helm chart URL
Mar 1, 2026
0fc3714
chore: Update Helm chart URL
Mar 2, 2026
dd02d23
chore: Update Epinio Version for EP on RD
Mar 2, 2026
d5c9cc7
chore: Update Helm chart URL
Mar 2, 2026
98957d6
chore: Update Epinio Version for EP on RD
Mar 2, 2026
b048631
chore: Update Epinio Version for EP on RD
Mar 3, 2026
661726d
chore: Update Helm chart URL
Mar 3, 2026
7c36f01
chore: Update Epinio Version for EP on RD
Mar 3, 2026
f1b4454
chore: Update Helm chart URL
Mar 3, 2026
43bdefc
chore: docs: update Epinio Version Information to 1.13.9
Mar 3, 2026
e53eda1
chore: Set latest docusaurus version
Mar 3, 2026
859493a
chore: Update Helm chart URL
Mar 3, 2026
5db6daf
chore: Update Epinio Version for EP on RD
Mar 3, 2026
8341c26
chore: docs: update Epinio Version Information to 1.13.9
Mar 3, 2026
ebf0e1a
chore: docs: update Epinio Installation URL with version 1.13.9
Mar 3, 2026
7ca689f
chore: docs: update Epinio Swagger URL with version 1.13.9
Mar 3, 2026
3e3f3d6
chore: docs: update Epinio Swagger URL with version 1.13.8
Mar 4, 2026
fccf4d9
chore: Update Epinio Version for EP on RD
Mar 4, 2026
133f555
chore: docs: update Epinio Version Information to 1.13.8
Mar 4, 2026
40840d7
chore: Update Helm chart URL
Mar 4, 2026
ca3f484
chore: docs: update Epinio Version Information to 1.13.8
Mar 4, 2026
0abce8f
chore: docs: update Epinio Installation URL with version 1.13.8
Mar 4, 2026
68afc6c
chore: Update Epinio Version for EP on RD
Mar 4, 2026
73ac531
chore: Update Helm chart URL
Mar 4, 2026
db822cd
chore: Update Helm chart URL
Mar 5, 2026
b659a2c
chore: Update Epinio Version for EP on RD
Mar 5, 2026
6b8e503
chore: Update Helm chart URL
Mar 5, 2026
5716d29
chore: Update Epinio Version for EP on RD
Mar 5, 2026
e73b833
chore: Update Epinio Version for EP on RD
Mar 6, 2026
539f9f0
chore: Update Helm chart URL
Mar 6, 2026
f875646
chore: Update Helm chart URL
Mar 6, 2026
7e94b0a
chore: Update Epinio Version for EP on RD
Mar 6, 2026
2301e2e
chore: docs: update Epinio Version Information to 1.13.9
Mar 7, 2026
6b50970
chore: Update Helm chart URL
Mar 7, 2026
2c17e0d
chore: Update Epinio Version for EP on RD
Mar 7, 2026
87d316e
chore: docs: update Epinio Swagger URL with version 1.13.9
Mar 7, 2026
c29ec21
chore: docs: update Epinio Version Information to 1.13.9
Mar 7, 2026
6886f2f
chore: docs: update Epinio Installation URL with version 1.13.9
Mar 7, 2026
3964692
chore: Update Helm chart URL
Mar 7, 2026
b80b4bd
chore: Update Epinio Version for EP on RD
Mar 7, 2026
42e3baa
chore: Update Epinio Version for EP on RD
Mar 8, 2026
e78afaa
chore: Update Helm chart URL
Mar 8, 2026
c014e7a
chore: Update Helm chart URL
Mar 9, 2026
4eb5243
chore: Update Epinio Version for EP on RD
Mar 9, 2026
0fa2cfe
chore: Update Helm chart URL
Mar 9, 2026
7f66017
chore: Update Epinio Version for EP on RD
Mar 9, 2026
262933f
chore: Update Epinio Version for EP on RD
Mar 10, 2026
b74823a
chore: Update Helm chart URL
Mar 10, 2026
49b89c6
chore: Update Epinio Version for EP on RD
Mar 10, 2026
2a1ddba
chore: Update Helm chart URL
Mar 10, 2026
97056f8
chore: Update Epinio Version for EP on RD
Mar 10, 2026
648484b
chore: Update Helm chart URL
Mar 10, 2026
0ede6d1
chore: Update Helm chart URL
Mar 10, 2026
1ae37a9
chore: Update Epinio Version for EP on RD
Mar 10, 2026
2e45761
chore: Update Epinio Version for EP on RD
Mar 11, 2026
5ed4266
chore: Update Helm chart URL
Mar 11, 2026
728ca76
chore: Update Helm chart URL
Mar 11, 2026
d1b1d2f
chore: Update Epinio Version for EP on RD
Mar 11, 2026
c270725
chore: Update Helm chart URL
Mar 12, 2026
2987e63
chore: Update Epinio Version for EP on RD
Mar 12, 2026
72bd890
chore: Update Helm chart URL
Mar 12, 2026
794ccd8
chore: Update Epinio Version for EP on RD
Mar 12, 2026
511e936
chore: Update Epinio Version for EP on RD
Mar 13, 2026
290c2b7
chore: Update Helm chart URL
Mar 13, 2026
6c669eb
chore: Update Helm chart URL
Mar 13, 2026
fcd3db6
chore: Update Epinio Version for EP on RD
Mar 13, 2026
f82065b
chore: Update Helm chart URL
Mar 14, 2026
bf8c574
chore: Update Epinio Version for EP on RD
Mar 14, 2026
1ef9862
chore: Update Epinio Version for EP on RD
Mar 14, 2026
4b50dcf
chore: Update Helm chart URL
Mar 14, 2026
7be78d0
chore: Update Epinio Version for EP on RD
Mar 15, 2026
bd1f61a
chore: Update Helm chart URL
Mar 15, 2026
47d5720
chore: Update Helm chart URL
Mar 15, 2026
9a33388
chore: Update Epinio Version for EP on RD
Mar 15, 2026
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
22 changes: 11 additions & 11 deletions docs/installation/install_epinio_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,15 @@ The following commands were tested using cosign version 2.1.1.
Instead of signing all release assets, Epinio signs a file containing checksums for the release assets.
From the repository you can download the three files:

- `epinio_1.13.8_checksums.txt.pem`,
- `epinio_1.13.8_checksums.txt.sig`,
- `epinio_1.13.8_checksums.txt`
- `epinio_1.13.9_checksums.txt.pem`,
- `epinio_1.13.9_checksums.txt.sig`,
- `epinio_1.13.9_checksums.txt`


```
curl -LO https://github.com/epinio/epinio/releases/download/v1.13.8/epinio_1.13.8_checksums.txt.pem
curl -LO https://github.com/epinio/epinio/releases/download/v1.13.8/epinio_1.13.8_checksums.txt.sig
curl -LO https://github.com/epinio/epinio/releases/download/v1.13.8/epinio_1.13.8_checksums.txt
curl -LO https://github.com/epinio/epinio/releases/download/v1.13.9/epinio_1.13.9_checksums.txt.pem
curl -LO https://github.com/epinio/epinio/releases/download/v1.13.9/epinio_1.13.9_checksums.txt.sig
curl -LO https://github.com/epinio/epinio/releases/download/v1.13.9/epinio_1.13.9_checksums.txt
```

Once you have the three files locally, you can execute the following command
Expand All @@ -84,9 +84,9 @@ Once you have the three files locally, you can execute the following command
cosign verify-blob \
--certificate-identity-regexp "https://github.com/epinio/epinio" \
--certificate-oidc-issuer "https://token.actions.githubusercontent.com" \
--cert epinio_1.13.8_checksums.txt.pem \
--signature epinio_1.13.8_checksums.txt.sig \
epinio_1.13.8_checksums.txt
--cert epinio_1.13.9_checksums.txt.pem \
--signature epinio_1.13.9_checksums.txt.sig \
epinio_1.13.9_checksums.txt
```

A successful output looks like
Expand All @@ -103,7 +103,7 @@ Before verifying the file integrity, you should first verify the checksum file s
Once you’ve downloaded both the checksums and your binary, you can verify integrity by running:

```
sha256sum --ignore-missing -c epinio_1.13.8_checksums.txt
sha256sum --ignore-missing -c epinio_1.13.9_checksums.txt
```

:::note
Expand All @@ -121,7 +121,7 @@ Run `epinio version` to test the successful installation.

```bash
> epinio version
Epinio Version: v1.13.8
Epinio Version: v1.13.9
Go Version: go1.20
```

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ keywords: [epinio, kubernetes, rancher, rancher desktop]

This How-to uses the following versions:

* \\\[epinio helm chart 1.13.8\]\\\(https://github.com/epinio/helm-charts/releases/tag/epinio-1.13.8\)
* \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\[epinio helm chart 1.13.9\]\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\(https://github.com/epinio/helm-charts/releases/tag/epinio-1.13.9\)
* Rancher Desktop 1.20.0

## Rancher Desktop prerequisites
Expand Down
2 changes: 1 addition & 1 deletion docs/references/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ curl -u your-username-here:password-here https://epinio.your-system-domain/api/v

The responses are all JSON objects, except for some cases where you get an error before the request reaches the Epinio server (e.g. because of bad cluster configuration).

The endpoints are documented in the [OpenAPI Spec](https://www.openapis.org/) format. You can find the definition of the API here: https://github.com/epinio/epinio/blob/v1.13.8/docs/references/api/swagger.json
The endpoints are documented in the [OpenAPI Spec](https://www.openapis.org/) format. You can find the definition of the API here: https://github.com/epinio/epinio/blob/v1.13.9/docs/references/api/swagger.json

__Make sure__ you change to the Epinio release you have deployed.

Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-1.13.9/explanations/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Explanations",
"position": 4,
"collapsed": true
}
190 changes: 190 additions & 0 deletions versioned_docs/version-1.13.9/explanations/advanced.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
---
sidebar_label: "Advanced topics"
title: "Advanced topics"
description: Advanced topics in Epinio application development environments
keywords: [epinio, kubernetes, advanced topics]
---

## Prerequisites

There are some components, such as an Ingress controller and a Certificate Manager,
required in a Kubernetes cluster before an Epinio installation.
The Epinio helm chart doesn't deploy these components.

### Ingress controller

On a Kubernetes cluster, certain services need to be reachable from outside the cluster.
For Epinio, the `API server` is one of them.
Some applications deployed with Epinio might also need to be reachable from outside.

One way to expose services externally is by creating
[Ingress resources](https://kubernetes.io/docs/concepts/services-networking/ingress/).
Ingress resources on their own, have no effect.
They're merely descriptions of the needed routing.
An Ingress controller handles the implementation of this routing.

:::note

Most clusters have an Ingress controller deployed by default.
Install [Traefik](https://doc.traefik.io/traefik/providers/kubernetes-ingress/),
or another, if an Ingress controller is absent.
The project uses Traefik in Epinio CI to test Epinio.

There is installation documentation for
[Traefik](../installation/install_epinio.md#ingress-controller)

:::

Epinio creates an Ingress resource for the Epinio API server and each application deployed.

### Cert-manager

[Cert-manager documentation](https://cert-manager.io/docs/)

Cert-manager is a Kubernetes controller that generates and renews certificates.
You need these certificates to securely serve the endpoints over TLS
(for example, the Epinio API server).

Epinio supports options when it comes to certificate issuers
(Let's Encrypt, your own private CA, self signed certs).
Cert-manager simplifies the handling of certificate issuers within Epinio.

You can read more about certificate issuers in the
[certificate issuers documentation](../howtos/other/certificate_issuers.md)

## Epinio installed components

The official, supported, way to install Epinio is with the
[Epinio Helm chart](https://artifacthub.io/packages/helm/epinio/epinio).
This Helm chart installs Epinio and it's component dependencies,
listed below, needed for Epinio to work.

### Epinio API server

The main component of Epinio is the API server.
The same `epinio` binary is both the server and the CLI.
The server starts with the `epinio server` command within a Kubernetes Pod, configured for Epinio.

Epinio CLI and web UI functionality are implemented using
the endpoints provided by the Epinio API server component.
For example, when the user asks Epinio to "push" an application,
the CLI contacts the "Upload", "Stage" and "Deploy" endpoints of the Epinio API to:

- upload the application code
- create a container image for the application using this code
- run the application on the cluster.

The Epinio API server runs on the cluster.
It's reached using Kubernetes resources like
Deployments, Services, Ingresses and Secrets.

### Reflector

[Relector documentation](https://github.com/emberstack/kubernetes-reflector)

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.

### Minio

[Minio project link](https://github.com/minio/minio)

Minio is a storage solution implementing the same API as [Amazon S3](https://aws.amazon.com/s3/).

When the user pushes an application using a source code directory
(with the [`epinio push`](../references/commands/cli/epinio_push.md) command),
the CLI packages the source code into a tarball.
It then uploads it to the Epinio API server.
The API server copies that to the configured S3 storage for
use during the staging of the application.

When installing Epinio, you choose to use external S3 compatible storage,
or let Epinio install one of Minio or s3gw on the cluster.
You can see a [How-to here](../howtos/customization/setup_external_s3.md).

### s3gw

[The s3gw project link](https://github.com/aquarist-labs/s3gw)

S3gw is a lightweight S3-compatible solution.
You can specify it in the Epinio Helm chart as an alternative to Minio or an external S3 provider.

### Container registry

The result of Epinio's application staging is a container image.
You use this image to create a Kubernetes deployment to run the application code.
The staging job writes the image to a container registry.
There is further information in the
[detailed push process](detailed-push-process.md) documentation.

By default, the Epinio installation deploys a container registry inside the Kubernetes cluster, making the process fast and convenient.

Epinio comes with two consumers of this registry:

- Staging job - pushing the images
- Kubernetes - pulling the images when creating a deployment for the application

All consumers should communicate with the registry using TLS to encrypt communication.
Epinio controls the staging job and it ensures that it trusts the CA used to sign the registry certificate.
Achieving the same for Kubernetes requires configuration that's impossible from within the cluster,
therefore Epinio has no way to ensure that it trusts the CA.
Epinio runs in a pod of the cluster and can't have permission to change cluster settings.
Changes are only possible, from outside, by a cluster administrator.

There are 3 options:

1. Let the Epinio user manually configure Kubernetes to trust the CA
1. Use a well-known trusted CA, so there's no configuration needed
1. Don't encrypt the communication at all

Currently Epinio doesn't support the first 2 options.
If `containerregistry.enabled` is `true` during installation (default),
Epinio makes Kubernetes pull the images un-encrypted (the last option above).
If you need encryption, install the container registry manually
and configure as an ["external" registry](../howtos/customization/setup_external_registry.md)
during Epinio installation.

:::note

Communication between the staging job and container registry is TLS encrypted even when using the built-in container registry.

:::

## Other advanced topics

### Git pushing

The quick way of pushing an application, explained in
[Quickstart: push an application](../tutorials/quickstart.md#push-an-application),
uses a local directory containing a checkout of the application's sources.

Internally this is a [complex](detailed-push-process.md) procedure.
The client creates and uploads an archive (tarball or zip)
from the sources to the Epinio server,
copying into Epinio's internal (or external) S3 storage.
It's then copied from that storage to a `PersistentVolumeClaim`
to use in the job for staging.
Staging is the compilation and creation of the docker image
for use by the underlying Kubernetes cluster.

The process is different when using the Epinio client's "git mode".
In this mode [`epinio push`](../references/commands/cli/epinio_push.md)
doesn't take a local directory of sources,
but the location of a git repository and the id of the revision to use.
The client then asks the Epinio server to pull those sources and store them to the S3 storage.
The rest of the process is the same.

The syntax is

```console
epinio push --name NAME --git GIT-REPOSITORY-URL,REVISION
```

For comparison all the relevant syntax:

```console
epinio push
epinio push MANIFEST-PATH
epinio push --name NAME
epinio push --name NAME --path DIRECTORY
epinio push --name NAME --git GIT-REPOSITORY-URL,REVISION
```
Loading