Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs-gb/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs-gb/examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
7 changes: 3 additions & 4 deletions docs-gb/kubernetes/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down Expand Up @@ -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).
7 changes: 3 additions & 4 deletions docs-gb/kubernetes/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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/)
4 changes: 2 additions & 2 deletions docs-gb/metrics/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 1 addition & 3 deletions docs-gb/models/rclone.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion docs-gb/operational-monitoring/observability.md
Original file line number Diff line number Diff line change
@@ -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.
---

Expand Down
17 changes: 1 addition & 16 deletions docs-gb/operational-monitoring/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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://<my-endpoint-1>:8000`,`http://<my-endpoint-2>: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 |
Expand Down Expand Up @@ -92,21 +92,6 @@ helm install seldon-v2-runtime k8s/helm-charts/seldon-core-v2-runtime \
These can be applied by using the `-f <filename>` 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.\
Expand Down
2 changes: 1 addition & 1 deletion docs-gb/servers/servers.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs-gb/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading