diff --git a/docs/installation.md b/docs/installation.md index 84336f43..a100a79f 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -2,7 +2,7 @@ This document is a step-by-step guide that describes how to install Visio on a k8s cluster without AI features. -## Prerequisites +## Prerequisites for a kubernetes setup - k8s cluster with an nginx-ingress controller - an OIDC provider (if you don't have one, we will provide an example) @@ -12,14 +12,25 @@ This document is a step-by-step guide that describes how to install Visio on a k ### Test cluster -If you do not have a test cluster, you can install everything on a local kind cluster. In this case, the simplest way is to use our script **bin/start-kind.sh**. +If you do not have a kubernetes test cluster, you can install everything on a local kind cluster. In this case, the simplest way is to use our script located in this repo under **bin/start-kind.sh**. -To be able to use the script, you will need to install: +IMPORTANT: The kind method will only deploy meet as a local instance(127.0.0.1) that can only be accessed from the device where it has been deployed. + +To be able to use the script, you will need to install the following components: - Docker (https://docs.docker.com/desktop/) - Kind (https://kind.sigs.k8s.io/docs/user/quick-start/#installation) - Mkcert (https://github.com/FiloSottile/mkcert#installation) - Helm (https://helm.sh/docs/intro/quickstart/#install-helm) +- kubectl (https://kubernetes.io/docs/tasks/tools/) + +In order to initiate the local kind installation via **start-kind.sh** do the following: +1) Make sure administrator/root user context is able to execute mkcert, docker, kind etc. commands or the script might fail +2) Download the script to the device where the above components are installed +3) Make the script executable +4) Run the script with proper permissions (administrator/sudo etc.) + +The output of the script will resemble the below example: ``` $ ./bin/start-kind.sh @@ -99,7 +110,7 @@ When your k8s cluster is ready, you can start the deployment. This cluster is sp Please remember that \*.127.0.0.1.nip.io will always resolve to 127.0.0.1, except in the k8s cluster where we configure CoreDNS to answer with the ingress-nginx service IP. -## Preparation +## Preparation of components ### What will you use to authenticate your users ? @@ -111,7 +122,7 @@ If you haven't run the script **bin/start-kind.sh**, you'll need to manually cre $ kubectl create namespace meet ``` -If you have already run the script, you can skip this step and proceed to the next instruction. +If you have already run the script, you can skip this step and proceed to the next instruction. NOTE: Before you proceed, and is using the kind method, make sure you download this repo examples/ directory and its contents to the location where you will be executing the helm command. Helm will look for "examples/values.yaml" from based on the path it is being executed. ``` $ kubectl config set-context --current --namespace=meet @@ -232,7 +243,7 @@ meet meet.127.0.0.1.nip.io localhost 80, 44 meet-admin meet.127.0.0.1.nip.io localhost 80, 443 52m ``` -You can use Visio on https://meet.127.0.0.1.nip.io. The provisioning user in keycloak is meet/meet. +You can use Visio on https://meet.127.0.0.1.nip.io from the local device. The provisioning user in keycloak is meet/meet. ## All options