diff --git a/.cspell.json b/.cspell.json index bea7fab52..249d20a08 100644 --- a/.cspell.json +++ b/.cspell.json @@ -11,11 +11,13 @@ "CISA", "minikube", "srodenhuis", + "Traefik", "minio", "Alin", "APIV", "appgw", "binzx", + "civo", "drucker", "prope", "dtap", diff --git a/docs/for-devs/console/workloads.md b/docs/for-devs/console/workloads.md index e6ead3b08..0b7aefff3 100644 --- a/docs/for-devs/console/workloads.md +++ b/docs/for-devs/console/workloads.md @@ -65,9 +65,9 @@ Now click on `application` in the `Argocd` column of the workload in the list of ### BYO Helm chart 1. Enter a name for the workload -2. Enter the URL to the Git repo containing the Helm Chart or a Helm repository -3. Optionally (only when using a Git repo) add the relative directory path within the Git repository. Absolute paths cause errors. -4. Optionally (only when using a Chart registry) add the name of the Helm chart +2. Enter the URL to the Git repo containing the Helm Chart or a Helm repository. +3. Add the relative path to a directory within the Git repository. Use `./` when no directory is used. +4. Optionally (only when using a Chart registry) add the name of the Helm chart. 5. Enter the revision. In case of using a Git repo, this can be commit, tag, or branch. If omitted, will equal to HEAD. In case of using a Chart repository, this is a semver tag for the Chart's version 6. Click `Next` 7. Review the Values used to install the chart diff --git a/docs/for-ops/how-to/install-with-dns.md b/docs/for-ops/how-to/install-with-dns.md index 7815168ef..ed8eb2135 100644 --- a/docs/for-ops/how-to/install-with-dns.md +++ b/docs/for-ops/how-to/install-with-dns.md @@ -117,3 +117,47 @@ helm repo update helm install -f values.yaml otomi otomi/otomi ``` +## Civo DNS + +:::info +Civo support is comming soon! +::: + +Set up DNS in Civo: + +1. Under `Networking` in the Civo Dashboard, click `DNS` and then `Add a domain name` +2. Fill in a domain name and then click `Add domain` +3. Create a NS record in the zone where your domain is hosted and add the Civo name servers `ns0.civo.com` ans `ns1.civo.com` +4. Under `Settings`, `Profile`, click on the tab `Security` and copy the `API key` + +Install Otomi: + +5. Add the DNS configuration to the `values.yaml` to install Otomi: + +```yaml +cluster: + name: my-cluster # choose a name for your cluster + provider: civo + domainSuffix: your-domain.com # your domain name +otomi: + hasExternalDNS: true # required +dns: + domainFilters: + - your-domain.com + provider: + civo: + apiToken: "" +apps: + cert-manager: + issuer: letsencrypt + stage: production + email: admin@your-domain.com +``` + +6. Install Otomi: + +```yaml +helm repo add otomi https://otomi.io/otomi-core +helm repo update +helm install -f values.yaml otomi otomi/otomi +``` \ No newline at end of file diff --git a/docs/for-ops/how-to/switch-to-dns.md b/docs/for-ops/how-to/switch-to-dns.md index 242d9ccf9..6b4960c92 100644 --- a/docs/for-ops/how-to/switch-to-dns.md +++ b/docs/for-ops/how-to/switch-to-dns.md @@ -15,8 +15,7 @@ When Otomi is installed with minimal values, a custom CA is generated and Otomi ## Step 2: Provide DNS values -- In the left menu, click on `DNS` under Platform Settings. This option will only become active after External DNS is enabled in step 1 -- Provide the DNS zone name used by the Teams tom publish URLs on +- Go back to the `Settings` and click `DNS` - Provide the Domain filter and optionally the Zone id filters - Select your Provider - Provide the required values @@ -24,21 +23,21 @@ When Otomi is installed with minimal values, a custom CA is generated and Otomi ## Step 3: Set cluster domain suffix -- In the left menu, click on `Cluster` under Platform Settings +- Go back to the `Settings` and click `Cluster` - Provide the cluster Domain Suffix - Click on `Submit` ## Step 4 (optional): Use Let's Encrypt -Let's encrypt requires a DNS zone. So if you would like to start using Let's Encrypt as a CA, now you can. +Let's Encrypt requires a DNS zone. So if you would like to start using Let's Encrypt as a CA, now you can. - Click on `Apps` under platform -- Click on the `CertManager` app -- Click on `values` +- Click on the `cert-manager` app +- Click on the `values` tab - Fill in an email address with a valid domain name (required!) - Under `Issuer`, click on `Lets Encrypt` -- Use `Production` or `Staging` +- Select `Production` - Click on `Submit` ## Step 5: Deploy Changes @@ -51,8 +50,7 @@ Wait for the Drone runner to finish: kubectl get pod -n drone-pipelines -w ``` - -## Step 6: Adjust the web hook in Gitea +## Step 6: Adjust the webhook in Gitea Open Gitea and follow these steps: @@ -69,21 +67,24 @@ First sign in to the Otomi Console using the new domain name: `https://otomi.