Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(helm): helm-docs installation + version bump #5635

Merged
merged 2 commits into from
May 29, 2024
Merged
Changes from 1 commit
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
Prev Previous commit
use older version of helm-docs to avoid update issues
RafalSkolasinski committed May 24, 2024
commit c383b302355c1b5fdea3491f82e0ad13ce445f79
2 changes: 1 addition & 1 deletion helm-charts/Makefile
Original file line number Diff line number Diff line change
@@ -13,7 +13,7 @@ docs:
helm-docs -o README.md -t ../README.md.tpl

install:
go install github.com/norwoodj/helm-docs/cmd/helm-docs@v1.13.1
go install github.com/norwoodj/helm-docs/cmd/helm-docs@f66fdbd6fe

package:
mkdir -p build && \
27 changes: 23 additions & 4 deletions helm-charts/seldon-abtest/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,31 @@
# seldon-abtest

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)
![Version: 0.2.0](https://img.shields.io/static/v1?label=Version&message=0.2.0&color=informational&style=flat-square)

Chart to deploy an AB test in Seldon Core v1. Allows you to split traffic between two models.

## Usage

To use this chart, you will first need to add the `seldonio` Helm repo:

```bash
helm repo add seldonio https://storage.googleapis.com/seldon-charts
helm repo update
```

Once that's done, you should then be able to use the inference graph template as:

```bash
helm template $MY_MODEL_NAME seldonio/seldon-abtest --namespace $MODELS_NAMESPACE
```

Note that you can also deploy the inference graph directly to your cluster
using:

```bash
helm install $MY_MODEL_NAME seldonio/seldon-abtest --namespace $MODELS_NAMESPACE
```

**Homepage:** <https://github.com/SeldonIO/seldon-core>

## Source Code
@@ -25,6 +47,3 @@ Chart to deploy an AB test in Seldon Core v1. Allows you to split traffic betwee
| replicas | int | `1` | |
| separate_pods | bool | `true` | |
| traffic_modela_percentage | float | `0.5` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
27 changes: 23 additions & 4 deletions helm-charts/seldon-benchmark-workflow/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,31 @@
# seldon-benchmark-workflow

![Version: 0.1](https://img.shields.io/badge/Version-0.1-informational?style=flat-square)
![Version: 0.1](https://img.shields.io/static/v1?label=Version&message=0.1&color=informational&style=flat-square)

Seldon Core v1 Benchmark Workflow

## Usage

To use this chart, you will first need to add the `seldonio` Helm repo:

```bash
helm repo add seldonio https://storage.googleapis.com/seldon-charts
helm repo update
```

Once that's done, you should then be able to use the inference graph template as:

```bash
helm template $MY_MODEL_NAME seldonio/seldon-benchmark-workflow --namespace $MODELS_NAMESPACE
```

Note that you can also deploy the inference graph directly to your cluster
using:

```bash
helm install $MY_MODEL_NAME seldonio/seldon-benchmark-workflow --namespace $MODELS_NAMESPACE
```

## Source Code

* <https://github.com/SeldonIO/seldon-core>
@@ -43,6 +65,3 @@ Seldon Core v1 Benchmark Workflow
| workflow.parallelism | int | `1` | |
| workflow.paramDelimiter | string | `"|"` | |
| workflow.useNameAsGenerateName | string | `"false"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
21 changes: 17 additions & 4 deletions helm-charts/seldon-core-analytics/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,27 @@
# seldon-core-analytics

![Version: 1.19.0-dev](https://img.shields.io/badge/Version-1.19.0--dev-informational?style=flat-square) ![AppVersion: 1.19.0-dev](https://img.shields.io/badge/AppVersion-1.19.0--dev-informational?style=flat-square)
![Version: 1.19.0-dev](https://img.shields.io/static/v1?label=Version&message=1.19.0--dev&color=informational&style=flat-square)

Prometheus and Grafana installation with a basic Grafana dashboard showing
the default Prometheus metrics exposed by Seldon for each inference graph
deployed.

## Usage

To use this chart, you will first need to add the `seldonio` Helm repo:

```bash
helm repo add seldonio https://storage.googleapis.com/seldon-charts
helm repo update
```

Once that's done, you should then be able to deploy the chart as:

```bash
kubectl create namespace seldon-system
helm install seldon-core-analytics seldonio/seldon-core-analytics --namespace seldon-system
```

**Homepage:** <https://github.com/SeldonIO/seldon-core>

## Source Code
@@ -53,6 +69,3 @@ deployed.
| prometheus.server.persistentVolume.mountPath | string | `"/seldon-data"` | |
| prometheus.service_type | string | `"ClusterIP"` | |
| rbac.enabled | bool | `true` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
21 changes: 17 additions & 4 deletions helm-charts/seldon-core-loadtesting/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,25 @@
# seldon-core-loadtesting

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)
![Version: 0.2.0](https://img.shields.io/static/v1?label=Version&message=0.2.0&color=informational&style=flat-square)

Loadtesting for Seldon Core v1

## Usage

To use this chart, you will first need to add the `seldonio` Helm repo:

```bash
helm repo add seldonio https://storage.googleapis.com/seldon-charts
helm repo update
```

Once that's done, you should then be able to deploy the chart as:

```bash
kubectl create namespace seldon-system
helm install seldon-core-loadtesting seldonio/seldon-core-loadtesting --namespace seldon-system
```

**Homepage:** <https://github.com/SeldonIO/seldon-core>

## Source Code
@@ -30,6 +46,3 @@ Loadtesting for Seldon Core v1
| oauth.secret | string | `"secret"` | |
| replicaCount | int | `1` | |
| rest.pathPrefix | string | `nil` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
21 changes: 17 additions & 4 deletions helm-charts/seldon-core-operator/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,25 @@
# seldon-core-operator

![Version: 1.19.0-dev](https://img.shields.io/badge/Version-1.19.0--dev-informational?style=flat-square) ![AppVersion: 1.19.0-dev](https://img.shields.io/badge/AppVersion-1.19.0--dev-informational?style=flat-square)
![Version: 1.19.0-dev](https://img.shields.io/static/v1?label=Version&message=1.19.0--dev&color=informational&style=flat-square)

Seldon Core CRD and controller helm chart for Kubernetes.

## Usage

To use this chart, you will first need to add the `seldonio` Helm repo:

```bash
helm repo add seldonio https://storage.googleapis.com/seldon-charts
helm repo update
```

Once that's done, you should then be able to deploy the chart as:

```bash
kubectl create namespace seldon-system
helm install seldon-core-operator seldonio/seldon-core-operator --namespace seldon-system
```

## Source Code

* <https://github.com/SeldonIO/seldon-core>
@@ -112,6 +128,3 @@ Seldon Core CRD and controller helm chart for Kubernetes.
| storageInitializer.memoryRequest | string | `"100Mi"` | |
| usageMetrics.enabled | bool | `false` | |
| webhook.port | int | `4443` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
27 changes: 23 additions & 4 deletions helm-charts/seldon-mab/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,33 @@
# seldon-mab

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)
![Version: 0.2.0](https://img.shields.io/static/v1?label=Version&message=0.2.0&color=informational&style=flat-square)

Chart to deploy a multi-armed bandits router over two Seldon Core v1 deployments,
so that traffic is sent to the best performing model.
You will need to utilize both the `predict` and `send_feedback` API methods.

## Usage

To use this chart, you will first need to add the `seldonio` Helm repo:

```bash
helm repo add seldonio https://storage.googleapis.com/seldon-charts
helm repo update
```

Once that's done, you should then be able to use the inference graph template as:

```bash
helm template $MY_MODEL_NAME seldonio/seldon-mab --namespace $MODELS_NAMESPACE
```

Note that you can also deploy the inference graph directly to your cluster
using:

```bash
helm install $MY_MODEL_NAME seldonio/seldon-mab --namespace $MODELS_NAMESPACE
```

**Homepage:** <https://github.com/SeldonIO/seldon-core>

## Source Code
@@ -39,6 +61,3 @@ You will need to utilize both the `predict` and `send_feedback` API methods.
| predictorLabels.version | string | `"1.19.0-dev"` | |
| replicas | int | `1` | |
| sdepLabels.app | string | `"seldon"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
27 changes: 23 additions & 4 deletions helm-charts/seldon-od-model/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,31 @@
# seldon-od-model

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)
![Version: 0.2.0](https://img.shields.io/static/v1?label=Version&message=0.2.0&color=informational&style=flat-square)

Chart to deploy an outlier detector as a single model with Seldon Core v1.

## Usage

To use this chart, you will first need to add the `seldonio` Helm repo:

```bash
helm repo add seldonio https://storage.googleapis.com/seldon-charts
helm repo update
```

Once that's done, you should then be able to use the inference graph template as:

```bash
helm template $MY_MODEL_NAME seldonio/seldon-od-model --namespace $MODELS_NAMESPACE
```

Note that you can also deploy the inference graph directly to your cluster
using:

```bash
helm install $MY_MODEL_NAME seldonio/seldon-od-model --namespace $MODELS_NAMESPACE
```

**Homepage:** <https://github.com/SeldonIO/seldon-core>

## Source Code
@@ -55,6 +77,3 @@ Chart to deploy an outlier detector as a single model with Seldon Core v1.
| predictorLabels.version | string | `"v1"` | |
| replicas | int | `1` | |
| sdepLabels.app | string | `"seldon"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
27 changes: 23 additions & 4 deletions helm-charts/seldon-od-transformer/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,31 @@
# seldon-od-transformer

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)
![Version: 0.2.0](https://img.shields.io/static/v1?label=Version&message=0.2.0&color=informational&style=flat-square)

Chart to deploy an outlier detector as a transformer in a Seldon Core v1 inference graph.

## Usage

To use this chart, you will first need to add the `seldonio` Helm repo:

```bash
helm repo add seldonio https://storage.googleapis.com/seldon-charts
helm repo update
```

Once that's done, you should then be able to use the inference graph template as:

```bash
helm template $MY_MODEL_NAME seldonio/seldon-od-transformer --namespace $MODELS_NAMESPACE
```

Note that you can also deploy the inference graph directly to your cluster
using:

```bash
helm install $MY_MODEL_NAME seldonio/seldon-od-transformer --namespace $MODELS_NAMESPACE
```

**Homepage:** <https://github.com/SeldonIO/seldon-core>

## Source Code
@@ -53,6 +75,3 @@ Chart to deploy an outlier detector as a transformer in a Seldon Core v1 inferen
| predictorLabels.version | string | `"v1"` | |
| replicas | int | `1` | |
| sdepLabels.app | string | `"seldon"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
27 changes: 23 additions & 4 deletions helm-charts/seldon-openvino/README.md
Original file line number Diff line number Diff line change
@@ -2,10 +2,32 @@

> **:exclamation: This Helm Chart is deprecated!**

![Version: 0.1](https://img.shields.io/badge/Version-0.1-informational?style=flat-square)
![Version: 0.1](https://img.shields.io/static/v1?label=Version&message=0.1&color=informational&style=flat-square)

Proxy integration to deploy models optimized for Intel OpenVINO in Seldon Core v1

## Usage

To use this chart, you will first need to add the `seldonio` Helm repo:

```bash
helm repo add seldonio https://storage.googleapis.com/seldon-charts
helm repo update
```

Once that's done, you should then be able to use the inference graph template as:

```bash
helm template $MY_MODEL_NAME seldonio/seldon-openvino --namespace $MODELS_NAMESPACE
```

Note that you can also deploy the inference graph directly to your cluster
using:

```bash
helm install $MY_MODEL_NAME seldonio/seldon-openvino --namespace $MODELS_NAMESPACE
```

## Source Code

* <https://github.com/SeldonIO/seldon-core>
@@ -33,6 +55,3 @@ Proxy integration to deploy models optimized for Intel OpenVINO in Seldon Core v
| predictorLabels.version | string | `"v1"` | |
| sdepLabels.app | string | `"seldon"` | |
| tfserving_proxy.image | string | `"seldonio/tfserving-proxy:0.2"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
27 changes: 23 additions & 4 deletions helm-charts/seldon-single-model/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,31 @@
# seldon-single-model

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)
![Version: 0.2.0](https://img.shields.io/static/v1?label=Version&message=0.2.0&color=informational&style=flat-square)

Chart to deploy a machine learning model in Seldon Core v1.

## Usage

To use this chart, you will first need to add the `seldonio` Helm repo:

```bash
helm repo add seldonio https://storage.googleapis.com/seldon-charts
helm repo update
```

Once that's done, you should then be able to use the inference graph template as:

```bash
helm template $MY_MODEL_NAME seldonio/seldon-single-model --namespace $MODELS_NAMESPACE
```

Note that you can also deploy the inference graph directly to your cluster
using:

```bash
helm install $MY_MODEL_NAME seldonio/seldon-single-model --namespace $MODELS_NAMESPACE
```

**Homepage:** <https://github.com/SeldonIO/seldon-core>

## Source Code
@@ -33,6 +55,3 @@ Chart to deploy a machine learning model in Seldon Core v1.
| model.uri | string | `""` | Model's URI for prepackaged model server |
| protocol | string | `"seldon"` | |
| replicas | int | `1` | Number of replicas for the predictor |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)