Skip to content

Commit

Permalink
Merge pull request #41 from redkubes/fix/broken-page-links
Browse files Browse the repository at this point in the history
fix/ added .md to internal routes and fixed broken links
  • Loading branch information
dennisvankekem authored Jan 3, 2024
2 parents 1d95012 + 2f37052 commit ff1e464
Show file tree
Hide file tree
Showing 42 changed files with 115 additions and 115 deletions.
2 changes: 1 addition & 1 deletion community/expectations.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Consequently, as a community we expect that all active participants in the commu

### Review comments

Because reviewers are often the first points of contact between new members of the community and can significantly impact the first impression of the Otomi community, reviewers are especially important in shaping the Otomi community. Reviewers are highly encouraged to not only abide by the [code of conduct](code-of-conduct) but are strongly encouraged to go above and beyond the code of conduct to promote a collaborative, respectful Otomi community.
Because reviewers are often the first points of contact between new members of the community and can significantly impact the first impression of the Otomi community, reviewers are especially important in shaping the Otomi community. Reviewers are highly encouraged to not only abide by the [code of conduct](code-of-conduct.md) but are strongly encouraged to go above and beyond the code of conduct to promote a collaborative, respectful Otomi community.

### Review latency

Expand Down
6 changes: 3 additions & 3 deletions community/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Before submitting code to Otomi, you should first complete the following prerequ

### Code of Conduct

Please make sure to read and observe the [Code of Conduct](code-of-conduct) and
[Community Values](community-values)
Please make sure to read and observe the [Code of Conduct](code-of-conduct.md) and
[Community Values](values.md)

### Developer guide

Expand All @@ -33,4 +33,4 @@ It is not required to set up a developer environment in order to contribute to O

Otomi is a community project. Consequently, it is wholly dependent on its community to provide a productive, friendly and collaborative environment.

Please read and review the [Contribution Expectations](expectations) for an understanding of code and review expectations.
Please read and review the [Contribution Expectations](expectations.md) for an understanding of code and review expectations.
2 changes: 1 addition & 1 deletion docs/apps/alertmanager.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Alertmanager

Alertmanager handles alerts sent by client applications such as the Prometheus server. It takes care of de-duplicating, grouping, and routing them to the correct receiver integration such as email, Slack, MS Teams, or OpsGenie. It also takes care of silencing and inhibition of alerts.

Alertmanager is configured to use the global values found under settings' [alerts](../for-ops/console/settings/alerts) and [co-monitoring](../for-ops/console/settings/co-monitoring).
Alertmanager is configured to use the global values found under settings' [alerts](../for-ops/console/settings/alerts.md) and [co-monitoring](../for-ops/console/settings/co-monitoring.md).

A team may decide to override some or all of them, in order to have alerts sent to their own endpoints. Self-service rights to alerting must be enabled for the team (enabled by default for all teams). When running Otomi in multi-tenant mode, each team is provided a dedicated alertmanger instance.

Expand Down
2 changes: 1 addition & 1 deletion docs/apps/certmanager.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The wildcard certificate must be valid for the following domain `*.<cluster.doma
:::

:::info
Setting Cert-Manager to use Letsencrypt requires DNS availability of the requesting domains, and forces Otomi to install [ExternalDNS](external-dns). Because a lot of DNS settings are used by other Otomi contexts, all DNS configuration can be found [here](../for-ops/console/settings/dns).
Setting Cert-Manager to use Letsencrypt requires DNS availability of the requesting domains, and forces Otomi to install [ExternalDNS](external-dns.md). Because a lot of DNS settings are used by other Otomi contexts, all DNS configuration can be found [here](../for-ops/console/settings/dns.md).
:::

## Configuration Values
Expand Down
2 changes: 1 addition & 1 deletion docs/apps/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ title: Grafana
sidebar_label: Grafana
---

Otomi uses Grafana to visualize [Prometheus](prometheus) metrics and [Loki](loki) logs. Team members are automatically given `Editor` role, while admins are also given `Admin` role. It is possible to make configuration changes directly in Grafana, but only to non-conflicting settings. Data sources are preconfigured and must not be edited as changes will be lost when Grafana is redeployed.
Otomi uses Grafana to visualize [Prometheus](prometheus.md) metrics and [Loki](loki.md) logs. Team members are automatically given `Editor` role, while admins are also given `Admin` role. It is possible to make configuration changes directly in Grafana, but only to non-conflicting settings. Data sources are preconfigured and must not be edited as changes will be lost when Grafana is redeployed.
2 changes: 1 addition & 1 deletion docs/apps/loki.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Loki
sidebar_label: Loki
---

Loki aggregates all the container logs from the platform and stores them in a storage endpoint of choice (defaults to PVC). When Otomi is installed in multi-tenancy mode (see [here](../for-ops/console/settings/otomi) it will split logs from team namespaces and make them available only to team members. Otomi provides shortcuts to selections of logs based on interest. Otomi splits logs per team, installs a dedicated Grafana instance per team and configures authentication for Grafana to allow access for team members only.
Loki aggregates all the container logs from the platform and stores them in a storage endpoint of choice (defaults to PVC). When Otomi is installed in multi-tenancy mode (see [here](../for-ops/console/settings/otomi.md)) it will split logs from team namespaces and make them available only to team members. Otomi provides shortcuts to selections of logs based on interest. Otomi splits logs per team, installs a dedicated Grafana instance per team and configures authentication for Grafana to allow access for team members only.

## Known issues

Expand Down
2 changes: 1 addition & 1 deletion docs/for-devs/console/apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ Here you will find more information about the app and how the app is integrated

### Shortcuts

Create shortcuts to open the app at a target path. Created shortcuts will also become visable in the [Shortcuts](shortcuts) section.
Create shortcuts to open the app at a target path. Created shortcuts will also become visable in the [Shortcuts](shortcuts.md) section.
2 changes: 1 addition & 1 deletion docs/for-devs/get-started/lab-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ We assume you (or the platform administrator) have:
- 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 in the `Istio` and `Nginx Ingress` apps.
For the [Use OpenTelemery](lab-27.md) Lab, the Tempo app needs to be enabled together with tracing in the `Istio` and `Nginx Ingress` apps.

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
Expand Down
2 changes: 1 addition & 1 deletion docs/for-devs/get-started/lab-11.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ In the example above, we used the `Digest` update strategy. The `Semver` strateg

## Expose the service

Now go to the [Expose services](lab-18) lab and expose the `green` service. When the service is created, go to `Services` in the left menu and click on the Url of the `green` service. What do you see?
Now go to the [Expose services](lab-18.md) lab and expose the `green` service. When the service is created, go to `Services` in the left menu and click on the Url of the `green` service. What do you see?

## Make code change to trigger a new build

Expand Down
6 changes: 3 additions & 3 deletions docs/for-devs/get-started/lab-22.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Check if the ServiveMonitor has been picked up by Prometheus:

Okay, our metrics are now being scraped by the Team's Prometheus. Before we continue, let's first generate some load:

1. Go to the [Expose services](lab-18) lab and expose the `custom-metrics` service
1. Go to the [Expose services](lab-18.md) lab and expose the `custom-metrics` service

2. Run the following command in your terminal:

Expand Down Expand Up @@ -96,5 +96,5 @@ To see the metrics:

Prometheus is now scraping our custom metrics. You can now use these metrics to:

- Create a dashboard in Grafana in the lab [Create custom dashboards](lab-30)
- Create rules and send alerts in the lab [Create custom rules](lab-31)
- Create a dashboard in Grafana in the lab [Create custom dashboards](lab-30.md)
- Create rules and send alerts in the lab [Create custom rules](lab-31.md)
2 changes: 1 addition & 1 deletion docs/for-devs/get-started/lab-23.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ When your application is deployed, you would of course like to get an alert when

## Monitor your application for availability

- [Create a Service](lab-7) for your app in Otomi. The service can have an Exposure ingress of type `Cluster` or `Ingress`
- [Create a Service](lab-7.md) for your app in Otomi. The service can have an Exposure ingress of type `Cluster` or `Ingress`

- Open the Prometheus

Expand Down
4 changes: 2 additions & 2 deletions docs/for-devs/get-started/lab-28.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ For this we are going to deploy the stable version (blue), introduce a new versi

For this lab we need the 2 images (`blue` and `green`) we already created in the previous labs. If you haven't created the blue and green images, first complete these 2 labs:

- [Build images](lab-6)
- [Trigger builds](lab-26)
- [Build images](lab-6.md)
- [Trigger builds](lab-26.md)

## Create a workload from the developer catalog

Expand Down
2 changes: 1 addition & 1 deletion docs/for-devs/get-started/lab-29.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ In the Info tab you'll see some information about the Chart like the version and

![catalog](../../img/catalog-3.png)

From here you can create a Workload using the Catalog template by adding a name and changing the values. Go to the [next lab](lab-13) to create a workload.
From here you can create a Workload using the Catalog template by adding a name and changing the values. Go to the [next lab](lab-13.md) to create a workload.
2 changes: 1 addition & 1 deletion docs/for-devs/get-started/lab-30.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Create custom dashboards
sidebar_label: Create custom dashboards
---

In the lab [Using custom metrics](lab-22) we created a Workload with a ServiceMonitor so the Team's Prometheus can scrape our custom metrics. In this lab we are going to create a custom Grafana dashboard and add the dashboard to a Configmap so the Team's Grafana will automatically load the dashboard.
In the lab [Using custom metrics](lab-22.md) we created a Workload with a ServiceMonitor so the Team's Prometheus can scrape our custom metrics. In this lab we are going to create a custom Grafana dashboard and add the dashboard to a Configmap so the Team's Grafana will automatically load the dashboard.

## Create a dashboard in Grafana

Expand Down
2 changes: 1 addition & 1 deletion docs/for-devs/get-started/lab-8.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,5 @@ The secret in Vault will now be synchronized to Kubernetes and can be used by th

:::info

In this part we only covered using generic secrets. See [here](../console/secrets) to see how you can create TLS and pull secrets
In this part we only covered using generic secrets. See [here](../console/secrets.md) to see how you can create TLS and pull secrets
:::
2 changes: 1 addition & 1 deletion docs/for-devs/get-started/lab-9.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In this case we'll use a demo app called hello. If you like you can clone the re
git clone https://github.com/redkubes/nodejs-helloworld.git
```

And then tag and build the image as you have done in the [Push images](lab-5) lab.
And then tag and build the image as you have done in the [Push images](lab-5.md) lab.

## Create a Deployment and Service

Expand Down
48 changes: 24 additions & 24 deletions docs/for-devs/get-started/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,75 +12,75 @@ Welcome to Otomi! If you are going to use Otomi, these getting started labs are

**Make sure everything is ready to get started**

### [Prerequisites](lab-1)
### [Prerequisites](lab-1.md)

---

**Create code repositories and build images**


### [Create private Git repositories](lab-3)
### [Create private Git repositories](lab-3.md)

### [Create builds](lab-6)
### [Create builds](lab-6.md)

### [Trigger builds](lab-26)
### [Trigger builds](lab-26.md)

---

**Create workloads**

### [Create secrets](lab-8)
### [Create secrets](lab-8.md)

### [BYO manifest to create a workload](lab-10)
### [BYO manifest to create a workload](lab-10.md)

### [Explore the Catalog](lab-29)
### [Explore the Catalog](lab-29.md)

### [Create a workload using the developer catalog](lab-13)
### [Create a workload using the developer catalog](lab-13.md)

### [Configure the auto image updater](lab-11)
### [Configure the auto image updater](lab-11.md)

### [Create a PostgreSQL database](lab-24)
### [Create a PostgreSQL database](lab-24.md)

---

**Secure workloads**

### [Check policy compliance](lab-15)
### [Check policy compliance](lab-15.md)

### [Scan images for vulnerabilities](lab-7)
### [Scan images for vulnerabilities](lab-7.md)

### [Scan your running containers for vulnerabilities](lab-17)
### [Scan your running containers for vulnerabilities](lab-17.md)

---

**Expose workloads**

### [Publicly expose a service](lab-18)
### [Publicly expose a service](lab-18.md)

### [Configuring network policies](lab-19)
### [Configuring network policies](lab-19.md)

---

**Monitor and debug workloads**

### [View container logs](lab-20)
### [View container logs](lab-20.md)

### [View container metrics](lab-21)
### [View container metrics](lab-21.md)

### [Using custom metrics](lab-22)
### [Using custom metrics](lab-22.md)

### [Create custom dashboards](lab-30)
### [Create custom dashboards](lab-30.md)

### [Create custom rules](lab-31)
### [Create custom rules](lab-31.md)

### [Monitoring availability](lab-23)
### [Monitoring availability](lab-23.md)

### [Monitor databases](lab-25)
### [Monitor databases](lab-25.md)

---

**Advanced Labs**

### [Tracing with OpenTelemetry](lab-27)
### [Tracing with OpenTelemetry](lab-27.md)

### [Canary Deployments](lab-28)
### [Canary Deployments](lab-28.md)
4 changes: 2 additions & 2 deletions docs/for-ops/cli/deploying.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If you don't need encryption straight away please continue to the next step

:::

Otomi will encrypt any `secrets.*.yaml` files with [sops](https://github.com/mozilla/sops), but only if it finds `sops:` configuration details. In order to have access to the KMS credentials to encrypt/decrypt, a `.secrets` file needs to exist and have those credentials. Please `copy .secrets.sample .secrets` and fill it in with the credentials from the [prerequisites](/docs/installation/prerequisites).
Otomi will encrypt any `secrets.*.yaml` files with [sops](https://github.com/mozilla/sops), but only if it finds `sops:` configuration details. In order to have access to the KMS credentials to encrypt/decrypt, a `.secrets` file needs to exist and have those credentials. Please `copy .secrets.sample .secrets` and fill it in with the credentials from the [prerequisites](/docs/get-started/prerequisites.md).

Then you can run `otomi bootstrap`, which will result in the encryption and decryption of the secrets files.

Expand Down Expand Up @@ -76,7 +76,7 @@ The console allows for easy configuration of many settings but not all. Assuming

## 5. Configuration

Configuration can be performed much easier through the Otomi Console, so please refer to the [Otomi Console](/docs/for-ops/console/overview) documentation.
Configuration can be performed much easier through the Otomi Console, so please refer to the [Otomi Console](/docs/for-ops/console/overview.md) documentation.

However, chart configuration is not (yet) exposed through the console, so please look at the values repo's `env/charts/*` files to edit the configuration files.

Expand Down
Loading

0 comments on commit ff1e464

Please sign in to comment.