Skip to main content
Version: 1.2.0

Services

Most real world applications work together with other services to store data, logs, to exchange messages with other systems etc. The most common example is probably a database. There are at least 2 ways to connect an Epinio application to a Service. The first way is to provision the service manually and create an Epinio Configuration to define the Service connection details available to the application.

The second way lets Epinio provision the Service, and afterwards create a binding to your application with the epinio service bind command. For additional information, please refer to the epinio service page.

How does it work?

Epinio is very flexible on how a service is provisioned. Many public cloud providers maintain their own operators (e.g. Azure). There are also projects like Crossplane that allow services provisioning for various public cloud providers. All these solutions work by creating custom resources on a cluster, and a controller will create the desired service. This shared method allows Epinio to stay agnostic of the provisioning method. You only need to create a Helm chart with the needed resources and describe how to install the Service with Epinio. The same method can be used with "in-cluster" services (e.g. a MySQL database running on the same cluster as Epinio). Actually, the Epinio services available by default are based on off-the-shelf Helm charts from Bitnami and their names are suffixed with -dev because in the provided default configuration they might not be suitable for production usage.

Provision a database

Here is an example on how to provision a database and make it available to some running application:

  • Push a sample app

    $ epinio app push -n sample --container-image-url splatform/sample-app
  • [Optional] List catalog services

    $ epinio service catalog
  • Provision an in-cluster database

    $ epinio service create mysql-dev mydb
  • Wait until it's ready (status should be "deployed")

    $ epinio service show mydb
  • Bind the database secrets to the application

    $ epinio service bind mydb sample
  • Check that the database secrets are available to the application

    $ epinio app exec sample

    🚢 Executing a shell
    Namespace: workspace
    Application: sample
    cnb@sample-7bc756989-tjvt9:/$ cat /configurations/workspace-mydb-mysql/
    ...
    cnb@sample-7bc756989-tjvt9:/$ exit

At this point, it's up to the application to make use of that secret. The helm chart used for this example doesn't write the hostname of the database in the generated secret. That's because the Helm chart wasn't created specifically for Epinio. To figure out the hostname, you might need to know how Kubernetes DNS works.

For the example above, the hostname is: workspace-mydb-mysql.workspace.svc.cluster.local.

When you are done with this example, you can delete all generated resources with the following commands:

$ epinio service delete mydb
$ epinio app delete sample