external-svc

External Service

Seamlessly connect external services to your Kubernetes environment.

Prerequisites

Note

You may refer to Orked for help with setting up a Kubernetes cluster that meets all the following prerequisites.

• Kubernetes 1.19+
• Helm 3.2.0+

---

Preflight checklist

Important

The following items are required to be set up prior to installing this chart.

This section does not apply to this chart.

---

Recommended configurations

Note

The following configuration recommendations might not be the default settings for this chart but are highly recommended. Please carefully consider them before configuring your installation.

This section does not apply to this chart.

---

Application configurations

Note

The following configurations are expected or recommended to be set up from within the application after completing the installation.

This section does not apply to this chart.

---

How to add the chart repo

1. Add the repo to your local helm client:

   helm repo add mika https://irfanhakim-as.github.io/charts

2. Update the repo to retrieve the latest versions of the packages:

   helm repo update

---

How to install or upgrade a chart release

1. Get the values file of the External Service chart or an existing installation (release).

   Get the latest External Service chart values file for a new installation:

   helm show values mika/external-svc > values.yaml

   Alternatively, get the values file of an existing External Service release:

   helm get values ${releaseName} --namespace ${namespace} > values.yaml

   Replace ${releaseName} and ${namespace} accordingly.

2. Edit your External Service values file with the intended configurations:

   nano values.yaml

   Pay extra attention to the descriptions and sample values provided in the chart values file.

3. Install a new release for External Service or upgrade an existing External Service release:

   helm upgrade --install ${releaseName} mika/external-svc --namespace ${namespace} --create-namespace --values values.yaml --wait

   Replace ${releaseName} and ${namespace} accordingly.

4. Verify that your External Service release has been installed:

   helm ls --namespace ${namespace} | grep "${releaseName}"

   Replace ${namespace} and ${releaseName} accordingly. This should return the release information if the release has been installed.

---

How to uninstall a chart release

Caution

Uninstalling a release will irreversibly delete all the resources associated with the release, including any persistent data.

1. Uninstall the desired release:

   helm uninstall ${releaseName} --namespace ${namespace} --wait

   Replace ${releaseName} and ${namespace} accordingly.

2. Verify that the release has been uninstalled:

   helm ls --namespace ${namespace} | grep "${releaseName}"

   Replace ${namespace} and ${releaseName} accordingly. This should return nothing if the release has been uninstalled.

---

Chart configurations

Key	Type	Default	Description
ingress.clusterIssuer	string	""	The name of the cluster issuer for Ingress. Default: "letsencrypt-dns-prod".
ingress.customAnnotations	list	[]	Additional configuration annotations to be added to the Ingress resource. Items: .prefix, .name, .value.
ingress.domains	list	[]	Domain configurations. Items: .name, .port, .www.
ingress.enabled	bool	false	Specifies whether Ingress should be enabled for hosting External Service services.
services	list	[]	Service configurations. Items: .host, .name, .nodePort, .port, .targetPort, .type.