Skip to content

Commit

Permalink
Update instructions for helm chart repo
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
  • Loading branch information
alexellis committed Sep 1, 2021
1 parent ac4e181 commit fd17a28
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 27 deletions.
23 changes: 16 additions & 7 deletions chart/inlets-http-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,20 @@ Use it to deploy one or more inlets PRO HTTP tunnel servers to your Kubernetes c

# Use your Kubernetes cluster for inlets-pro HTTP exit-servers

Clone the repository:
Install [arkade](https://arkade.dev/), which is used in the tutorial to install Kubernetes software.

```bash
git clone https://github.com/inlets/inlets-pro
cd inlets-pro/chart/inlets-http-server
curl -sLS https://dl.arkade.dev | sh # Move to /usr/local/bin/
curl -sLS https://dl.arkade.dev | sudo sh # Moved automatically.
```

Install helm with `arkade get helm`.

You also need to add the helm chart repository:

```bash
$ helm repo add inlets-pro https://inlets.github.io/inlets-pro/charts/
$ helm repo update
```

## Setup cert-manager, Ingress and a DNS01 certificate
Expand Down Expand Up @@ -114,6 +123,8 @@ dataPlaneIngresses:
fullnameOverride: ""
```
Above: `values-live.yaml`

Since we are using a wildcard TLS record (`wildcard-inlets-router-cert`), this needs to be set as the `secretName`.

Then install the chart:
Expand All @@ -122,10 +133,9 @@ Then install the chart:
export NAME=client1
helm upgrade --namespace inlets \
--install client1 ./chart/inlets-http-server \
--install client1 inlets-pro/inlets-http-server \
--set tokenSecretName=inlets-$NAME-token \
-f ./chart/inlets-http-server/values.yaml \
-f ./chart/inlets-http-server/values-live.yaml
-f values-live.yaml
```

Now connect a client:
Expand All @@ -144,4 +154,3 @@ Access your tunnelled services:

* https://faas.exit.o6s.io
* https://prometheus.exit.o6s.io

26 changes: 13 additions & 13 deletions chart/inlets-pro-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,20 @@ You should decide whether you want to expose the remote service to the world, or

You will need to set up an inlets PRO TCP server so that the client has an endpoint to connect to. Create a server manually and then configure inlets-pro, or use [inletsctl](https://github.com/inlets/inletsctl) to create a preconfigured cloud VM, or use the helm chart for the inlets-pro server to install the server into a Pod.

Then you will need the `helm` binary, the easiest way to get this is via [arkade](https://dl-get-arkade.dev):
Install [arkade](https://arkade.dev/), which is used in the tutorial to install Kubernetes software.

```bash
curl -sL https://dl-get-arkade.dev | sudo sh
chmod +x arkade
sudo mv arkade /usr/local/bin/
curl -sLS https://dl.arkade.dev | sh # Move to /usr/local/bin/
curl -sLS https://dl.arkade.dev | sudo sh # Moved automatically.
```

Install helm with `arkade get helm`.

You also need to add the helm chart repository:

arkade get helm
arkade get helm [--version VER]
```bash
$ helm repo add inlets-pro https://inlets.github.io/inlets-pro/charts/
$ helm repo update
```

### Install a client for a server using Auto TLS
Expand Down Expand Up @@ -52,10 +57,8 @@ kubectl create secret generic -n $NS \
kubectl create secret generic -n $NS \
$TOKEN_NAME --from-literal token=$SERVER_TOKEN

git clone https://github.com/inlets/inlets-pro
cd inlets-pro/chart

helm upgrade --install grafana-tunnel ./inlets-pro-client \
helm upgrade --install grafana-tunnel inlets-pro/inlets-pro-client \
--namespace $NS \
--set tokenSecretName=$TOKEN_NAME \
--set url=$URL \
Expand Down Expand Up @@ -93,10 +96,7 @@ kubectl create secret generic -n default \
kubectl create secret generic -n default \
$TOKEN_NAME --from-literal token=$SERVER_TOKEN

git clone https://github.com/inlets/inlets-pro
cd inlets-pro/chart

helm upgrade --install prometheus-tunnel ./inlets-pro-client \
helm upgrade --install prometheus-tunnel inlets-pro/inlets-pro-client \
--namespace openfaas \
--set tokenSecretName=$TOKEN_NAME \
--set url=$URL \
Expand Down
26 changes: 19 additions & 7 deletions chart/inlets-pro/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,27 @@ You will need a cloud Kubernetes cluster and access to a sub-domain available an

You can run this on any Intel or ARM cluster.

Download [arkade](https://get-arkade.dev/), or use helm to install pre-reqs
Install [arkade](https://arkade.dev/), which is used in the tutorial to install Kubernetes software.

```bash
curl -sLS https://dl.arkade.dev | sh # Move to /usr/local/bin/
curl -sLS https://dl.arkade.dev | sudo sh # Moved automatically.
```

Install helm with `arkade get helm`.

You also need to add the helm chart repository:

```bash
$ helm repo add inlets-pro https://inlets.github.io/inlets-pro/charts/
$ helm repo update
```

* Install cert-manager - (`arkade install cert-manager`)
* Install ingress-nginx - (`arkade install ingress-nginx`)
* Install helm with `arkade get helm`

It is assumed that you installed `kubectl` when you created your Kubernetes cluster.
It is assumed that you installed `kubectl` when you created your Kubernetes cluster, otherwise run `arkade get kubectl`.

### Install an Issuer

Expand Down Expand Up @@ -67,7 +82,7 @@ kubectl create secret generic inlets-pro-secret --from-literal token=$TOKEN
echo $TOKEN > token.txt
```

### Install the inlets-pro chart
### Install the inlets-pro TCP server chart

The chart will deploy two Kubernetes services, an Ingress record and a Deployment to run the inlets-pro server process.

Expand All @@ -81,10 +96,7 @@ Make any changes you need.
```bash
export DOMAIN="prometheus.example.com"

git clone https://github.com/inlets/inlets-pro
cd inlets-pro/chart

helm upgrade --install prometheus-tunnel ./inlets-pro \
helm upgrade --install prometheus-tunnel inlets-pro/inlets-pro \
--set domain $DOMAIN
```

Expand Down

0 comments on commit fd17a28

Please sign in to comment.