diff --git a/docs/explanation/design-goals.md b/docs/explanation/design-goals.md index 8e2b559..405e6fb 100644 --- a/docs/explanation/design-goals.md +++ b/docs/explanation/design-goals.md @@ -18,7 +18,7 @@ There are several design goals we want to accomplish with COS: * Provide a set of high-quality observability charmed operators that are designed to work well on their own, and better together. -* Make COS run on Kubernetes, with specific focus on [MicroK8s](https://microk8s.io/), to achieve a very "appliance-like" user experience. +* Make COS run on Kubernetes, with specific focus on [MicroK8s](https://canonical.com/microk8s), to achieve a very "appliance-like" user experience. * Ensure a consistent, cohesive experience: all alerts go through Alertmanager, Grafana can plot all telemetry, etc. diff --git a/docs/how-to/troubleshooting.md b/docs/how-to/troubleshooting.md index 2971f12..bec368e 100644 --- a/docs/how-to/troubleshooting.md +++ b/docs/how-to/troubleshooting.md @@ -21,7 +21,7 @@ apply, although you will need to tailor the exact steps and commands to your set ### Checklist - You have run `juju trust traefik --scope=cluster` -- The [MetalLB MicroK8s add-on](https://microk8s.io/docs/addon-metallb) is enabled. +- The [MetalLB MicroK8s add-on](https://canonical.com/microk8s/docs/addon-metallb) is enabled. - Traefik's service type is ``LoadBalancer``. - An external IP address is assigned to Traefik. @@ -62,7 +62,7 @@ This can happen when: - MetalLB has only one IP in its range but you deployed two instances of Traefik, or when Traefik is forcefully removed (`--force --no-wait`) and a new Traefik app is deployed immediately after. -- The [ingress](https://microk8s.io/docs/ingress) add-on is enabled. It's possible +- The [ingress](https://canonical.com/microk8s/docs/ingress) add-on is enabled. It's possible that Nginx from the ingress add-on has claimed the `ExternalIP`. Disable Nginx and re-enable MetalLB. diff --git a/docs/reference/best-practices/storage.md b/docs/reference/best-practices/storage.md index af8167c..713ef5e 100644 --- a/docs/reference/best-practices/storage.md +++ b/docs/reference/best-practices/storage.md @@ -19,7 +19,7 @@ has a growth rate of about 50GB per day under normal operations. So, if you want a retention interval of about two months, you'll need 3TB of storage only for the telemetry. ## Set up distributed storage -In production, **do not** use hostPath storage ([`hostpath-storage`](https://microk8s.io/docs/addon-hostpath-storage) in MicroK8s; `local-storage` in Canonical K8s): +In production, **do not** use hostPath storage ([`hostpath-storage`](https://canonical.com/microk8s/docs/addon-hostpath-storage) in MicroK8s; `local-storage` in Canonical K8s): - `PersistentVolumeClaims` created by the host path storage provisioner are bound to the local node, so it is *impossible to move them to a different node*. - A `hostpath` volume can *grow beyond the capacity set in the volume claim manifest*. @@ -28,5 +28,5 @@ Use Ceph CSI. Refer to Canonical Kubernetes [snap](https://documentation.ubuntu. and [charm](https://documentation.ubuntu.com/canonical-kubernetes/latest/charm/howto/ceph-csi/) docs. ### MicroK8s -Use the [`rook-ceph`](https://microk8s.io/docs/addon-rook-ceph) add-on together with Microceph. -See the [Microceph tutorial](https://microk8s.io/docs/how-to-ceph). +Use the [`rook-ceph`](https://canonical.com/microk8s/docs/addon-rook-ceph) add-on together with Microceph. +See the [Microceph tutorial](https://canonical.com/microk8s/docs/how-to-ceph). diff --git a/docs/reference/best-practices/topology.md b/docs/reference/best-practices/topology.md index 990c36c..cf0dd9d 100644 --- a/docs/reference/best-practices/topology.md +++ b/docs/reference/best-practices/topology.md @@ -126,5 +126,5 @@ end ## References - High availability: [Canonical K8s](https://documentation.ubuntu.com/canonical-kubernetes/latest/snap/explanation/high-availability/), - [MicroK8s](https://microk8s.io/docs/high-availability). + [MicroK8s](https://canonical.com/microk8s/docs/high-availability). diff --git a/docs/reference/cos-components.md b/docs/reference/cos-components.md index 0005849..833c8cf 100644 --- a/docs/reference/cos-components.md +++ b/docs/reference/cos-components.md @@ -12,10 +12,10 @@ myst: | ------------------------------------------------------------------------ | --------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Catalogue](https://charmhub.io/catalogue-k8s) | K8s | | [Source](https://github.com/canonical/catalogue-k8s-operator), [issues](https://github.com/canonical/catalogue-k8s-operator/issues) | | [Grafana](https://charmhub.io/grafana-k8s) | K8s | | [Source](https://github.com/canonical/grafana-k8s-operator), [issues](https://github.com/canonical/grafana-k8s-operator/issues) | -| [Loki Coordinator](https://charmhub.io/loki-coordinator-k8s) | K8s | | [Source](https://github.com/canonical/loki-coordinator-k8s-operator), [issues](https://github.com/canonical/loki-coordinator-k8s-operator/issues) | -| [Loki Worker](https://charmhub.io/loki-worker-k8s) | K8s | | [Source](https://github.com/canonical/loki-worker-k8s-operator), [issues](https://github.com/canonical/loki-worker-k8s-operator/issues) | -| [Mimir Coordinator](https://charmhub.io/mimir-coordinator-k8s) | K8s | | [Source](https://github.com/canonical/mimir-coordinator-k8s-operator), [issues](https://github.com/canonical/mimir-coordinator-k8s-operator/issues) | -| [Mimir Worker](https://charmhub.io/mimir-worker-k8s) | K8s | | [Source](https://github.com/canonical/mimir-worker-k8s-operator), [issues](https://github.com/canonical/mimir-worker-k8s-operator/issues) | +| [Loki Coordinator](https://charmhub.io/loki-coordinator-k8s) | K8s | | [Source](https://github.com/canonical/loki-operators/tree/main/coordinator), [issues](https://github.com/canonical/loki-operators/issues) | +| [Loki Worker](https://charmhub.io/loki-worker-k8s) | K8s | | [Source](https://github.com/canonical/loki-operators/tree/main/worker), [issues](https://github.com/canonical/loki-operators/issues) | +| [Mimir Coordinator](https://charmhub.io/mimir-coordinator-k8s) | K8s | | [Source](https://github.com/canonical/mimir-operators/tree/main/coordinator), [issues](https://github.com/canonical/mimir-operators/issues) | +| [Mimir Worker](https://charmhub.io/mimir-worker-k8s) | K8s | | [Source](https://github.com/canonical/mimir-operators/tree/main/worker), [issues](https://github.com/canonical/mimir-operators/issues) | | [S3 Integrator](https://charmhub.io/s3-integrator) | Any | | [Source](https://github.com/canonical/s3-integrator), [issues](https://github.com/canonical/s3-integrator/issues) | | [Self-signed Certificates](https://charmhub.io/self-signed-certificates) | Any | | [Source](https://github.com/canonical/self-signed-certificates-operator), [issues](https://github.com/canonical/self-signed-certificates-operator/issues) | | [Tempo Coordinator](https://charmhub.io/tempo-coordinator-k8s) | K8s | | [Source](https://github.com/canonical/tempo-coordinator-k8s-operator), [issues](https://github.com/canonical/tempo-coordinator-k8s-operator/issues) | diff --git a/docs/tutorial/installation/cos-lite-microk8s-sandbox.md b/docs/tutorial/installation/cos-lite-microk8s-sandbox.md index 4eedec5..341d241 100644 --- a/docs/tutorial/installation/cos-lite-microk8s-sandbox.md +++ b/docs/tutorial/installation/cos-lite-microk8s-sandbox.md @@ -29,7 +29,7 @@ Let's go and deploy that bundle! ## Configure MicroK8s -For the COS Lite bundle deployment to go smoothly, make sure the following MicroK8s [addons](https://microk8s.io/docs/addons) are enabled: `dns`, `hostpath-storage` and `metallb`. +For the COS Lite bundle deployment to go smoothly, make sure the following MicroK8s [addons](https://canonical.com/microk8s/docs/addons) are enabled: `dns`, `hostpath-storage` and `metallb`. You can check this with `microk8s status`, and if any are missing, enable them with @@ -39,7 +39,7 @@ $ microk8s enable dns ```{note} While the following setup is sufficient for non-production environments, if you're looking for a more resilient storage option, -consider deploying MicroCeph on MicroK8s using this [guide](https://microk8s.io/docs/how-to-ceph). +consider deploying MicroCeph on MicroK8s using this [guide](https://canonical.com/microk8s/docs/how-to-ceph). ``` ```bash @@ -63,11 +63,11 @@ $ microk8s kubectl rollout status daemonset.apps/speaker -n metallb-system -w ``` ```{note} -If you have an HTTP proxy configured, you will need to give this information to MicroK8s. See [the proxy documentation](https://microk8s.io/docs/install-proxy) for details. +If you have an HTTP proxy configured, you will need to give this information to MicroK8s. See [the proxy documentation](https://canonical.com/microk8s/docs/install-proxy) for details. ``` ```{note} -By default, MicroK8s will use `8.8.8.8` and `8.8.4.4` as DNS servers, which can be adjusted. See [the DNS documentation](https://microk8s.io/docs/addon-dns) for details. +By default, MicroK8s will use `8.8.8.8` and `8.8.4.4` as DNS servers, which can be adjusted. See [the DNS documentation](https://canonical.com/microk8s/docs/addon-dns) for details. ``` ## Deploy the COS Lite bundle