diff --git a/docs-gb/cli/README.md b/docs-gb/cli/README.md index 29d59fc033..103f99ac60 100644 --- a/docs-gb/cli/README.md +++ b/docs-gb/cli/README.md @@ -11,7 +11,7 @@ make build-seldon-arm # for macOS ARM Then place the `bin/seldon` executable in your path. - * [cli docs](./docs/seldon.md) + * [cli docs](../cli/seldon.md) ## Environment Variables and Services diff --git a/docs-gb/examples/README.md b/docs-gb/examples/README.md index d36005a3eb..56a9049697 100644 --- a/docs-gb/examples/README.md +++ b/docs-gb/examples/README.md @@ -65,7 +65,7 @@ This section will provide some examples to allow operations with Seldon to be te ## Misc * [Checking Pipeline readiness](pipeline-ready-and-metadata.md) -* [Local Overcommit](local-overcommit-examples/) +* [Local Overcommit](local-overcommit-examples.md) ## Further Kubernetes Examples diff --git a/docs-gb/kubernetes/kafka.md b/docs-gb/kubernetes/kafka.md index 14eb33da22..34bfbaf2ab 100644 --- a/docs-gb/kubernetes/kafka.md +++ b/docs-gb/kubernetes/kafka.md @@ -27,8 +27,7 @@ We currently have tested and documented integration with following managed solut - Amazon MSK (security: SASL/SCRAM) - Azure Event Hub (security: SASL/PLAIN) -See our [Kafka security](../getting-started/kubernetes-installation/security.md#kafka) -section for configuration examples. +See our [Kafka security](../getting-started/kubernetes-installation/security/README.md#kafka) section for configuration examples. ## Self Hosted Kafka @@ -39,7 +38,7 @@ To install Kafka for testing purposed in your k8s cluster, we recommend to use [ {% hint style="info" %} **Note**: This page discuss how to install Strimzi Operator and create Kafka cluster for trial, dev, or testing purposes. -For production grade installation consult [Strimzi documentation](https://strimzi.io/documentation/) or use one of managed solutions mentioned [here](./index.md). +For production grade installation consult [Strimzi documentation](https://strimzi.io/documentation/) or use one of [managed solutions](#managed-kafka). {% endhint %} You can install and configure Strimzi using either Helm charts or our Ansible playbooks, both documented below. @@ -93,4 +92,4 @@ ansible-playbook playbooks/setup-ecosystem.yaml -e full_install=no -e install_ka ## Notes - You can check [kafka-examples](https://github.com/strimzi/strimzi-kafka-operator/tree/main/examples/kafka) for more details. - As we are using [KRaft](https://kafka.apache.org/documentation/#kraft), use Kafka version 3.4 or above. -- For security settings check [here](../getting-started/kubernetes-installation/security.md#kafka). +- For security settings check [here](../getting-started/kubernetes-installation/security/README.md#kafka). diff --git a/docs-gb/kubernetes/metrics.md b/docs-gb/kubernetes/metrics.md index e7700573d4..cffbbdb96a 100644 --- a/docs-gb/kubernetes/metrics.md +++ b/docs-gb/kubernetes/metrics.md @@ -14,8 +14,7 @@ provides an all-in-one package with the [Prometheus operator](https://github.com ### RBAC -You will need to modify the default RBAC installed by kube-prometheus as described -[here](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md#deploying-prometheus). +You will need to modify the default [RBAC installed by kube-prometheus](https://prometheus-operator.dev/docs/getting-started/introduction/). From the `prometheus` folder in the project run: @@ -45,8 +44,8 @@ reference [this](https://github.com/prometheus-operator/prometheus-operator/issu ## Example Grafana Dashboard -Check [metrics](../metrics.md) for more information. +Check [metrics](../operational-monitoring/observability.md) for more information. ## Reference -[Prometheus CRDs](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md) +[Prometheus CRDs](https://prometheus-operator.dev/docs/api-reference/api/) diff --git a/docs-gb/metrics/README.md b/docs-gb/metrics/README.md index 3efdc3724e..3b5ef7bb89 100644 --- a/docs-gb/metrics/README.md +++ b/docs-gb/metrics/README.md @@ -1,8 +1,8 @@ # Metrics There are two kinds of metrics present in Seldon Core 2: -* [operational metrics](./operational.md) -* [usage metrics](./usage.md) +* [operational metrics](../operational-monitoring/operational.md) +* [usage metrics](../operational-monitoring/usage.md) Operational metrics describe the performance of components in the system. Some examples of common operational considerations are memory consumption and CPU usage, request latency and throughput, and cache utilisation rates. diff --git a/docs-gb/models/rclone.md b/docs-gb/models/rclone.md index 9c814bbe2d..1585ecb0fc 100644 --- a/docs-gb/models/rclone.md +++ b/docs-gb/models/rclone.md @@ -10,6 +10,4 @@ We utilize [Rclone](https://rclone.org/) to copy model artifacts from a storage to the model servers. This allows users to take advantage of Rclones support for over 40\ cloud storage backends including Amazon S3, Google Storage and many others. -For local storage while developing see [here](../getting-started/docker-installation.md#local-models). - -For authorization needed for cloud storage when running on Kubernetes see [here](../../kubernetes/storage-secrets.md). +For authorization needed for cloud storage when running on Kubernetes see [here](../kubernetes/storage-secrets.md). diff --git a/docs-gb/operational-monitoring/observability.md b/docs-gb/operational-monitoring/observability.md index dc0fb395c6..b7b2c160a0 100644 --- a/docs-gb/operational-monitoring/observability.md +++ b/docs-gb/operational-monitoring/observability.md @@ -1,5 +1,5 @@ --- -description:nInstalling kube-prometheus-stack in the same Kubernetes cluster that hosts the +description: Installing kube-prometheus-stack in the same Kubernetes cluster that hosts the Seldon Core 2. --- diff --git a/docs-gb/operational-monitoring/usage.md b/docs-gb/operational-monitoring/usage.md index ec2a53e790..5bdf5f387c 100644 --- a/docs-gb/operational-monitoring/usage.md +++ b/docs-gb/operational-monitoring/usage.md @@ -56,7 +56,7 @@ The following environment variables control the behaviour of Hodometer, regardle | Flag | Format | Example | Description | | -------------------- | ---------------------------- | --------------------------------------------------- | -------------------------------------------------------------------------------- | | `METRICS_LEVEL` | string | feature | Level of detail for recorded metrics; one of `feature`, `resource`, or `cluster` | -| `EXTRA_PUBLISH_URLS` | comma-separated list of URLs | http://my-endpoint-1:8000,http://my-endpoint-2:8000 | Additional endpoints to publish metrics to | +| `EXTRA_PUBLISH_URLS` | comma-separated list of URLs | `http://:8000`,`http://:8000` | Additional endpoints to publish metrics to | | `SCHEDULER_HOST` | string | seldon-scheduler | Hostname for Seldon Core v2 scheduler | | `SCHEDULER_PORT` | integer | 9004 | Port for Seldon Core v2 scheduler | | `LOG_LEVEL` | string | info | Level of detail for application logs | @@ -92,21 +92,6 @@ helm install seldon-v2-runtime k8s/helm-charts/seldon-core-v2-runtime \ These can be applied by using the `-f ` switch when running Helm. {% endhint %} -### Docker Compose - -The [Compose setup](../getting-started/docker-installation/index.md) provides a pre-configured and opinionated,\ -yet still flexible, approach to using Seldon Core v2. - -Hodometer is defined as a service called `hodometer` in the Docker Compose manifest. It is automatically enabled\ -when running as per the installation instructions. - -You can disable Hodometer in Docker Compose by removing the corresponding service from the base manifest.\ -Alternatively, you can gate it behind a [profile](https://docs.docker.com/compose/profiles/).\ -If the service is already running, you can stop it directly using `docker-compose stop ...`. - -Configuration can be provided by environment variables when running `make` or directly invoking `docker-compose`.\ -The available variables are defined in the Docker Compose environment file, prefixed with `HODOMETER_`. - ### Extra publish URLs Hodometer can be instructed to publish metrics not only to Seldon, but also to any extra endpoints you specify.\ diff --git a/docs-gb/servers/servers.md b/docs-gb/servers/servers.md index 069d3746e5..8ffe326826 100644 --- a/docs-gb/servers/servers.md +++ b/docs-gb/servers/servers.md @@ -110,4 +110,4 @@ For some examples see [here](../examples/custom-servers.md). ## Autoscaling of Servers -Within docker we don't support this but for Kubernetes see [here](../kubernetes/autoscaling/) +Within docker we don't support this but for Kubernetes see [here](../scaling/README.md) diff --git a/docs-gb/upgrading.md b/docs-gb/upgrading.md index b4e7434dc5..7842945706 100644 --- a/docs-gb/upgrading.md +++ b/docs-gb/upgrading.md @@ -39,7 +39,7 @@ Previously, the labelling has been inconsistent across different versions of Sel mixture of `app` and `app.kubernetes.io/name` used. If using the Prometheus operator ("Kube Prometheus"), please apply the v2.7.0 manifests for Seldon Core 2\ -according to the [metrics documentation](../kubernetes/metrics.md). +according to the [metrics documentation](../docs-gb/kubernetes/metrics.md). Note that these manifests need to be adjusted to discover metrics endpoints based on the existing setup.