diff --git a/.cspell.json b/.cspell.json index ce726e4f7..48bbad431 100644 --- a/.cspell.json +++ b/.cspell.json @@ -7,12 +7,15 @@ "ABDEFHIJZ", "aspinu", "vultr", + "behaviour", "OVHcloud", "CISA", "minikube", "cloudnativepg", "srodenhuis", "Traefik", + "rbaumgar", + "ebpf", "minio", "Alin", "petclinc", diff --git a/docs/apps/drone.md b/docs/apps/drone.md index 9acf36ee7..3b21e6d6d 100644 --- a/docs/apps/drone.md +++ b/docs/apps/drone.md @@ -4,31 +4,6 @@ title: Drone sidebar_label: Drone --- -Otomi uses Drone to deploy changes from the values repo. As such, it is installed and configured by default. When no source control is configured, Otomi will deploy Gitea as Drone's git hosting dependency. - -You may use Otomi's Drone for other purposes if desired. - -## Configuration values - -### Source control - -Configure Drone to use another Git repository for `otomi-values`. The following sGit services are supported: - -- Bitbucket cloud -- Bitbucket server -- Gitea (external) -- Git hub -- Git lab -- Gogs - -### Debug - -Turns on debugging in Drone. - -### Tracing - -Turns on tracing in Drone - -### Resources - -Adjust default provided resource requests and limits for Drone Runner, Drone Server and Drone Agent \ No newline at end of file +:::info +Drone has been deprecated. We advise to use Tekton if you would need to create custom CI/CD pipelines +::: \ No newline at end of file diff --git a/docs/apps/external-dns.md b/docs/apps/external-dns.md index 8f3659e7d..ac8d76043 100644 --- a/docs/apps/external-dns.md +++ b/docs/apps/external-dns.md @@ -9,9 +9,5 @@ External-dns is required to make public service domains accessible by registerin The use of external-dns is a prerequisite for using the following features: - Harbor private registries for teams -- Builds (rely on Harbor) -- Projects (rely on Harbor) - -## Configuration values - -External-dns can be configured in the [DNS section](/docs/for-ops/console/settings/dns) of the Platform Setting \ No newline at end of file +- Builds (relies on Harbor) +- Projects (relies on Harbor) \ No newline at end of file diff --git a/docs/apps/falco.md b/docs/apps/falco.md index a64bb7a0f..81556f118 100644 --- a/docs/apps/falco.md +++ b/docs/apps/falco.md @@ -4,19 +4,22 @@ title: Falco sidebar_label: Falco --- -Falco can be used for thread detection. When turned on - -:::Notes: -Your deployed workloads may trigger one or more Falco rules. Hence, you may want to reconfigure some of the defaults. Something you consider as normal can be whitelisted in the Raw values of the Falco application. -::: +Falco can be used for thread detection. Before activating Falco, please first check which [Driver](https://falco.org/docs/event-sources/kernel/) to use. If you know which driver should be selected, activate Falco, go to the `Values`, select the `Driver` and submit changes. No `Deploy Changes` ## Configuration values -### Falco sidekick configuration -- Number of replica's of Falco Sidekick -- Minimum priority (default is informational). +### Driver settings + +Select the driver to use: + +- module +- ebpf (default) +- modern-bpf ### Resources -Adjust default provided resource requests and limits for Falco, Falco Sidekick and Falco Exporter. +Adjust default provided resource requests and limits for Falco and Falco Exporter. + +## Raw values +When Falco is installed, Otomi will add a set of rules to `white-list` all known behaviour. These rules are added using the Raw Values. \ No newline at end of file diff --git a/docs/apps/otel.md b/docs/apps/otel.md index 4601b512e..0d81e4db0 100644 --- a/docs/apps/otel.md +++ b/docs/apps/otel.md @@ -4,4 +4,4 @@ title: Open Telemetry Operator sidebar_label: Open Telemetry Operator --- -OpenTelemetry Operator is used to create a OTEL Collector to receive telemetry data from Istio and Nginx Ingress (and applications configured with Instrumentation) and export this data to the Tempo backend. Grafana can then be used to see the full traces. \ No newline at end of file +OpenTelemetry Operator is used to create an OTEL Collector to receive telemetry data from Istio and Nginx Ingress (and applications configured with Instrumentation) and export this data to the Tempo backend. Grafana can then be used to see traces. \ No newline at end of file diff --git a/docs/apps/thanos.md b/docs/apps/thanos.md index 2771e71af..ed12b60f4 100644 --- a/docs/apps/thanos.md +++ b/docs/apps/thanos.md @@ -4,4 +4,4 @@ title: Thanos sidebar_label: Thanos --- -Thanos can be enabled for multi-cluster long term metrics retention. \ No newline at end of file +Thanos can be enabled for multi-cluster metrics retention using an off-site object storage service. \ No newline at end of file diff --git a/docs/apps/vault.md b/docs/apps/vault.md index 5be349326..57b15f2c2 100644 --- a/docs/apps/vault.md +++ b/docs/apps/vault.md @@ -5,7 +5,7 @@ sidebar_label: Hashicorp Vault --- :::note -Hashicorp Vault is being deprecated in Otomi. We are going to replace this app with solution based on SealedSecrets. +Hashicorp Vault is being deprecated. The Otomi Secrets feature is soon going to be based on SealedSecrets. ::: HashiCorp Vault is a shared application for securely storing and managing secrets. Read more about Vault [here](https://www.vaultproject.io/docs/what-is-vault). diff --git a/docs/for-devs/console/catalog.md b/docs/for-devs/console/catalog.md new file mode 100644 index 000000000..b1e0a8894 --- /dev/null +++ b/docs/for-devs/console/catalog.md @@ -0,0 +1,50 @@ +--- +slug: catalog +title: Otomi Catalog +sidebar_label: Otomi Catalog +--- + +The Catalog is a library of curated Helm charts to create Kubernetes resources. By default the Catalog contains a set of Helm charts provided by Otomi to get started quickly, but they can also be modified depending on your requirements or be removed from the Catalog. + +The contents of the Catalog and the RBAC configuration (which Team can use which Helm chart) are managed by the platform administrator. Contact the platform administrator if you would like to add your own charts to use within your Team. + +## About Otomi Catalog quick starts + +The Catalog contains a set of Helm charts that can be used as quick starts. The following quick starts are available: + +### k8s-deployment + +The `otomi-quickstart-k8s-deployment` Helm chart can be used to create a Kubernetes `Deployment` (to deploy a single image), a `Service` and a `ServiceAccount`. Optionally a `HorizontalPodAutoscaler`, a Prometheus `ServiceMonitor` and a `Configmap` can be created. + +### k8s-deployment-otel + +The `otomi-quickstart-k8s-deployment-otel` Helm chart can be used to create a Kubernetes `Deployment` (to deploy a single image), a `Service`, a `ServiceAccount`, an `OpenTelemetryCollector` and an `Instrumentation`. Optionally a `HorizontalPodAutoscaler`, a Prometheus `ServiceMonitor` and a `Configmap` can be created. + +### k8s-deployments-canary + +The `otomi-quickstart-k8s-deployments-canary` Helm chart can be used to create 2 Kubernetes `Deployments` (to deploy 2 versions of an image), a `Service` and a `ServiceAccount`. Optionally a `HorizontalPodAutoscaler`, a Prometheus `ServiceMonitor` and a `Configmap` (for each version) can be created. + +### knative-service + +The `otomi-quickstart-knative-service` Helm chart can be used to create a Knative `Service` (to deploy a single image), a `Service` and a `ServiceAccount`. Optionally a Prometheus `ServiceMonitor` can be created. + + +## Using the Catalog + +1. Click on `Catalog` in the left menu + +2. You will now see all the templates that are available to use + +![catalog](../../img/catalog-1.png) + +3. Click on the `k8s-deployment` template + +![catalog](../../img/catalog-2.png) + +In the Info tab you'll see some information about the Chart like the version and additional instructions. + +3. Click on the `Values` tab + +![catalog](../../img/catalog-3.png) + +4. Continue to [create a workload](workloads.md) diff --git a/docs/for-devs/console/workloads.md b/docs/for-devs/console/workloads.md index 856a99150..b25f9d776 100644 --- a/docs/for-devs/console/workloads.md +++ b/docs/for-devs/console/workloads.md @@ -29,9 +29,9 @@ Before creating a workload from the developer catalog, we'll need the `repositor 2. Go to `Workloads` in the left menu and click on `New Workload` -3. Add a `Name` for the workload +3. Select a template from the catalog to use -4. Select a template from the catalog to use +4. Add a `Name` for the workload 5. (Optional) Configure the `Auto image updater`. Default is `Disabled`. diff --git a/docs/for-devs/get-started/lab-1.md b/docs/for-devs/get-started/lab-1.md index 1695ea11a..4a5d3e5a6 100644 --- a/docs/for-devs/get-started/lab-1.md +++ b/docs/for-devs/get-started/lab-1.md @@ -6,9 +6,13 @@ sidebar_label: Prerequisites Welcome to Otomi! If you are a developer and are going to use Otomi, this getting started guide is for you. In this first part we are going to make sure everything is ready to get started. +## Prerequisites + We assume the platform administrator has: -1. Activated the following applications: +1. Installed Otomi with DNS configured + +2. Activated the following applications: - Harbor - ArgoCD @@ -18,11 +22,11 @@ We assume the platform administrator has: - Trivy Operator - Gatekeeper (with option `Disable validating webhook` set to true) -For the [Use OpenTelemery](lab-27) Lab, the Tempo app needs to be enabled together with tracing at `Istio` and `Nginx Ingress` apps. +For the [Use OpenTelemery](lab-27) Lab, the Tempo app needs to be enabled together with tracing in the `Istio` and `Nginx Ingress` apps. -1. Created a team called `demo` -2. [Created an account](/docs/apps/keycloak#create-a-user-in-keycloak) and added your user the team group in Keycloak -3. Provided you with the following information: +3. Created a team called `demo` with `Managed prometheus and alert manager` enabled +4. [Created an account](/docs/apps/keycloak#create-a-user-in-keycloak) and added your user to the team group in Keycloak +5. Provided you with the following information: - The URL to access the Otomi web UI (Otomi Console) - Your login credentials @@ -36,4 +40,4 @@ When you have received the URL of the web UI and have a username/password, then After sign in, you will see this page: -![Team apps](../../img/team-apps.png) +![Team apps](../../img/team-apps.png) \ No newline at end of file diff --git a/docs/for-devs/get-started/lab-11.md b/docs/for-devs/get-started/lab-11.md index 61414b9b5..a466f9b55 100644 --- a/docs/for-devs/get-started/lab-11.md +++ b/docs/for-devs/get-started/lab-11.md @@ -48,7 +48,7 @@ Now go to the [Expose services](lab-18) lab and expose the `green` service. When In the Trigger Builds lab we already created a Build called `green` and configured it with a trigger. -Now go to the `green` repo in Gitea and change the color in the `green.html` to `orange`: +Now go to the `green` repo in Gitea and change the the welcome message: ```html @@ -59,7 +59,7 @@ Now go to the `green` repo in Gitea and change the color in the `green.html` to