Home / Keptn v1 Docs / Release 1.y.z / Installation / Choose access options

Choose access options

Access options

Before installing Keptn on your cluster, please also consider how you would like to access Keptn. Kubernetes provides the following four options:

Option 1: Expose Keptn via an LoadBalancer
Option 2: Expose Keptn via a NodePort
Option 3: Expose Keptn via a Ingress
Option 4: Access Keptn via a Port-forward

An overview of the four options is provided in the graphic below and the respective steps of all options are described below.

Option 1: Expose Keptn via a LoadBalancer

This option exposes Keptn externally using a cloud provider’s load balancer (if available).

Install Keptn: Use the Helm CLI to install Keptn on your cluster.

 helm install keptn keptn/keptn -n keptn --version=$KeptnVersion --create-namespace --set=apiGatewayNginx.type=LoadBalancer

Get Keptn endpoint: Get the EXTERNAL-IP of the api-gateway-nginx using the command below. The Keptn API endpoint is: http://<ENDPOINT_OF_API_GATEWAY>/api

kubectl -n keptn get service api-gateway-nginx

NAME                TYPE        CLUSTER-IP    EXTERNAL-IP                  PORT(S)   AGE
api-gateway-nginx   ClusterIP   10.117.0.20   <ENDPOINT_OF_API_GATEWAY>    80/TCP    44m

Optional: Store Keptn API endpoint in an environment variable:

For Linux and Mac:
```
KEPTN_ENDPOINT=http://<ENDPOINT_OF_API_GATEWAY>/api
```
For Windows:
```
$Env:KEPTN_ENDPOINT = 'http://<ENDPOINT_OF_API_GATEWAY>/api'
```
⚠️ Warning: If you do not set up TLS encryption, none of your traffic to and from the Keptn endpoint is encrypted.

Option 2: Expose Keptn via a NodePort

This option exposes Keptn on each Kubernetes Node’s IP at a static port. Therefore, please make sure that you can access the Kubernetes Nodes in your network.

Install Keptn: Use the Helm CLI to install Keptn on your cluster.

helm install keptn keptn/keptn -n keptn --version=$KeptnVersion \
   --create-namespace --set=apiGatewayNginx.type=NodePort

Get Keptn endpoint: Get the mapped port of the api-gateway-nginx using the command below.

API_PORT=$(kubectl get svc api-gateway-nginx -n keptn -o jsonpath='{.spec.ports[?(@.name=="http")].nodePort}')

Next, get the internal or external IP address of any Kubernetes node:

EXTERNAL_NODE_IP=$(kubectl get nodes -o jsonpath='{ $.items[0].status.addresses[?(@.type=="ExternalIP")].address }')
INTERNAL_NODE_IP=$(kubectl get nodes -o jsonpath='{ $.items[0].status.addresses[?(@.type=="InternalIP")].address }')

The Keptn API endpoint (either via the internal or external IP; try both if unsure) is: http://${INTERNAL_NODE_IP}:${API_PORT}/api or http://${EXTERNAL_NODE_IP}:${API_PORT}/api

Optional: Store Keptn API endpoint in an environment variable:

For Linux and Mac:

KEPTN_ENDPOINT=http://${EXTERNAL_NODE_IP}:${API_PORT}/api

For Windows:

$Env:KEPTN_ENDPOINT = 'http://${EXTERNAL_NODE_IP}:${API_PORT}/api'

⚠️ Warning: If you do not set up TLS encryption, all your traffic to and from the Keptn endpoint is not encrypted.

Option 3: Expose Keptn via an Ingress

Install Keptn: Use the Helm CLI to install Keptn on your cluster.

helm install keptn keptn/keptn -n keptn --version=$KeptnVersion --create-namespace

Install an ingress controller and create an ingress: First, install your favorite ingress controller and then apply an ingress object in the keptn namespace, that points to the service api-gateway-nginx on port 80. Note that the Kubernetes Ingress supports TLS encryption.

Note: Using Openshift 3.11 requires using a configuration for this platform.

Commonly used Ingress controllers are Istio and NGINX:

Istio provides an Ingress Controller. To install Istio, please refer to the official documentation.

Determine the ingress IP:

kubectl -n istio-system get svc istio-ingressgateway

Create an ingress-manifest.yaml manifest for an Ingress object in which you set IP-ADDRESS or your hostname and then apply the manifest. (Note: In the example below, nip.io is used as wildcard DNS for the IP address.)

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    kubernetes.io/ingress.class: istio
  name: api-keptn-ingress
  namespace: keptn
spec:
  rules:
  - host: <IP-ADDRESS>.nip.io
    http:
      paths:
      - path: /
        pathType: Prefix
        backend:
          service:
            name: api-gateway-nginx
            port:
              number: 80

kubectl apply -f ingress-manifest.yaml

Istio provides an Ingress Controller. To install Istio, please refer to the official documentation.
Determine the ingress IP:

kubectl -n istio-system get svc istio-ingressgateway

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    kubernetes.io/ingress.class: istio
  name: api-keptn-ingress
  namespace: keptn
spec:
  rules:
  - host: <IP-ADDRESS>.nip.io
    http:
      paths:
      - backend:
          serviceName: api-gateway-nginx
          servicePort: 80

kubectl apply -f ingress-manifest.yaml

To install an NGINX Ingress Controller, please refer to the official documentation.

Determine the ingress IP:

kubectl -n ingress-nginx get svc ingress-nginx

Create an ingress-manifest.yaml manifest for an ingress object in which you set IP-ADDRESS or your hostname and then apply the manifest. (Note: In the example below, nip.io is used as wildcard DNS for the IP address.)

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    kubernetes.io/ingress.class: nginx
  name: api-keptn-ingress
  namespace: keptn
spec:
  rules:
  - host: <IP-ADDRESS>.nip.io
    http:
      paths:
      - path: /
        pathType: Prefix
        backend:
          service:
            name: api-gateway-nginx
            port:
              number: 80

kubectl apply -f ingress-manifest.yaml

To install an NGINX Ingress Controller, please refer to the official documentation.

Determine the ingress IP:

kubectl -n ingress-nginx get svc ingress-nginx

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    kubernetes.io/ingress.class: nginx
  name: api-keptn-ingress
  namespace: keptn
spec:
  rules:
  - host: <IP-ADDRESS>.nip.io
    http:
      paths:
      - backend:
          serviceName: api-gateway-nginx
          servicePort: 80

kubectl apply -f ingress-manifest.yaml

Get Keptn endpoint: Get the HOST of the api-keptn-ingress using the command below. The Keptn API endpoint is: http://<HOST>/api

kubectl -n keptn get ingress api-keptn-ingress

NAME                HOSTS                  ADDRESS         PORTS   AGE
api-keptn-ingress   <HOST>                 x.x.x.x   80      48m

Optional: Store Keptn API endpoint in an environment variable:

For Linux and Mac:
```
KEPTN_ENDPOINT=http://<HOST>/api
```
For Windows:
```
$Env:KEPTN_ENDPOINT = 'http://<HOST>/api'
```

⚠️ Warning: If you do not set up TLS encryption, none of your traffic to and from the Keptn endpoint is encrypted.

Option 4: Access Keptn via a Port-forward

This option does not expose Keptn to the public but exposes Keptn on a cluster-internal IP.

Install Keptn: Use the Helm CLI to install Keptn on your cluster.

helm install keptn keptn/keptn -n keptn --version=$KeptnVersion \
  --create-namespace

Set up a port-forward: Configure the port-forward by using the command below.
```
kubectl -n keptn port-forward service/api-gateway-nginx 8080:80
```
By default, kubectl port-forward binds to 127.0.0.1. If you want to listen on any local address, add --address 0.0.0.0:
```
 kubectl -n keptn port-forward service/api-gateway-nginx 8080:80 --address 0.0.0.0
```
Get Keptn endpoint: The Keptn API endpoint is: http://localhost:8080/api
Optional: Store Keptn API endpoint in an environment variable:
```
KEPTN_ENDPOINT=http://localhost:8080/api
```

Change how to expose Keptn

If you would like to change the way of exposing Keptn, you can do this by re-installing Keptn and selecting the desired configuration. When the CLI asks you if you would like to overwrite the installation, confirm this with yes. This retains all your data, including the Git repos and events.

Kubernetes support & Cluster size

Install Keptn CLI