diff --git a/README.md b/README.md index b4d0d46..64d18cb 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ # Certificate Generator for Slice Gateway -The `gateway-certs-generator` is an opinionated single-file OpenVPN TLS certificate configuration generator for slice gateways. It's an enhancement to `easy-rsa` (typically bundled with OpenVPN). +The `gateway-certs-generator` is an opinionated single-file OpenVPN TLS certificate configuration generator for slice gateways. It enhances `easy-rsa` (typically bundled with OpenVPN). `easy-rsa` is a CLI tool/utility to build and manage a PKI CA. use the CLI tool `easy-rsa`. Using the tool, create a root certificate authority, and request and sign certificates including intermediate CAs and certificate revocation lists (CRL). ## Get Started -It is strongly recommended that you use a released version. +It is strongly recommended that you use a released version. -Please refer to our documentation on: -- [Get Started on KubeSlice](https://kubeslice.io/documentation/open-source/1.3.0/category/get-started) -- [Install KubeSlice](https://kubeslice.io/documentation/open-source/1.3.0/category/install-kubeslice) +Refer to our documentation on: +- [Get Started on KubeSlice](https://kubeslice.io/documentation/open-source/latest/category/get-started) +- [Install KubeSlice](https://kubeslice.io/documentation/open-source/latest/category/install-kubeslice) ## Build and Deploy Certificate Generator on a Kind Cluster @@ -23,7 +23,7 @@ Before you begin, make sure the following prerequisites are met: * You have prepared the environment to install [`kubeslice-controller`](https://github.com/kubeslice/kubeslice-controller) on the controller cluster and [`worker-operator`](https://github.com/kubeslice/worker-operator) on the worker cluster. For more information, see [Prerequisites](https://kubeslice.io/documentation/open-source/1.3.0/category/prerequisites). ### Set up Your Helm Repo -If you have not added avesha helm repo yet, add it. +If you have not added avesha `helm repo` yet, add it. ```console helm repo add avesha https://kubeslice.github.io/charts/ @@ -46,18 +46,18 @@ To download the latest docker image for gateway-certs-generator, click [here](ht cd gateway-certs-generator ``` -2. Modiy the image name variable `IMG` in the [`Makefile`](Makefile) to change the docker tag to be built. - The default image is set as `IMG ?= aveshasystems/gateway-certs-generator:latest`. Modify this if required. +2. Modify the image name variable `IMG` in the [`Makefile`](Makefile) to change the docker tag to be built. + The default image is set as `IMG ?= aveshasystems/gateway-certs-generator:latest`. Modify as needed. ```console make docker-build ``` -### Run Local Image on Kind Clusters +### Run Local Image on Kind Cluster 1. Load the gateway-certs-generator image into your kind cluster ([kind](https://kind.sigs.k8s.io/docs/user/quick-start/#loading-an-image-into-your-cluster)). If needed, replace `aveshasystems/gateway-certs-generator` with your locally built image name in the previous step. -* Note: If you use a named cluster, you must specify the name of the cluster you wish to load the images into. See [loading an image into your kind cluster](https://kind.sigs.k8s.io/docs/user/quick-start/#loading-an-image-into-your-cluster). +* Note: If you use a named cluster, specify the name of the cluster you wish to load the images into. See [loading an image into your kind cluster](https://kind.sigs.k8s.io/docs/user/quick-start/#loading-an-image-into-your-cluster). ```console kind load docker-image aveshasystems/gateway-certs-generator --name cluster-name @@ -69,10 +69,10 @@ To download the latest docker image for gateway-certs-generator, click [here](ht 2. Check the loaded image in the cluster. Modify the node name if required. -* Note: `kind-control-plane` is the name of the Docker container. Modify if needed. +* Note: `kind-control-plane` is the name of the Docker container. Modify as needed. ```console - docker exec -it kind-control-plane crictl images + docker exec -it kind-control-plane critical images ``` ### Deploy the Certificate Generator on a Cluster