Gateway Sidecar

The Slice VPN Gateway is a slice network service component that provides a secure VPN tunnel between any two clusters that are a part of the slice.

Get Started

Please refer to our documentation on:

• Get Started on KubeSlice
• Install KubeSlice

Prerequisites

Before you begin, make sure the following prerequisites are met:

• Docker is installed and running on your local machine.
• A running kind.
• kubectl is installed and configured.
• You have prepared the environment to install kubeslice-controller on the controller cluster and worker-operator on the worker cluster. For more information, see Prerequisites.

Build and Deploy Gateway Sidecar on a Kind Cluster

To download the latest gateway-sidecar docker hub image, click here.

The following command pulls the latest docker image:

docker pull aveshasystems/gw-sidecar:latest

Set up Your Helm Repo

If you have not added Avesha's helm repo yet, add it.

helm repo add avesha https://kubeslice.github.io/charts/

Upgrade Avesha's helm repo.

helm repo update

Build Docker Images

1. Clone the latest version of gateway sidecar from the master branch.

   git clone https://github.com/kubeslice/gateway-sidecar.git
   cd gateway-sidecar

2. Edit the VERSION variable in the Makefile to change the docker tag to be built. The image is set as docker.io/aveshasystems/kubeslice-gw-sidecar:$(VERSION) in the Makefile. Change this if required

   make docker-build
   

Run Locally on a Kind Cluster

1. You can load the gateway-sidecar docker image into a kind cluster.

   kind load docker-image my-custom-image:unique-tag --name clustername

   Example

   kind load docker-image aveshasystems/kubeslice-gw-sidecar:1.2.1 --name kind

2. Check the loaded image in the cluster. Modify the node name as required.

   docker exec -it <node-name> crictl images

   Example

   docker exec -it kind-control-plane crictl images

Deploy Gateway Sidecar on a Cluster

Update the chart values file called yourvaluesfile.yaml that you have previously created. Refer to the values.yaml to create yourvaluesfiel.yaml and update the gateway-sidecar image subsection to use the local image.

From the sample:

gateway:
  image: docker.io/aveshasystems/gw-sidecar
  tag: 0.1.0

Change it to:

gateway:
  image: <my-custom-image>
  tag: <unique-tag>

Deploy the Updated Chart

make chart-deploy VALUESFILE=yourvaluesfile.yaml

Verify the Installation

Verify the Gateway Sidecar Container is running by checking the status of gateway pod belonging to the kubeslice-system namespace.

kubectl describe pod <gateway pod name> -n kubeslice-system

License

Apache 2.0 License.