Skip to content

Commit

Permalink
Merge branch 'dev/aberg/add-directory-configuration' of github.com:wh…
Browse files Browse the repository at this point in the history
…ylabs/charts into dev/aberg/add-directory-configuration
  • Loading branch information
AnchorArray committed Jan 26, 2024
2 parents 695b74e + 2bf7523 commit 1afb8bf
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions charts/langkit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,33 +8,34 @@
## Prerequisites

### Credentials

Retrieve or [Create WhyLabs API Key](https://docs.whylabs.ai/docs/whylabs-capabilities/#access-token-management)
which must be stored in a `whylabs-api-key` Kubernetes secret, described below.
NOTE: Change the `--namespace` value if you will be deploying into a namespace other
than `langkit`.

Generate a random value for the `langkit-api-secret` Kubernetes secret, also
described below. This is required to call into the container.

Use the the following commands to create the secrets in your Kubernets cluster.
Change the `--namespace` value if you will be deploying into a namespace other
than `langkit`.
### Credentials
* Create a [WhyLabs API Key](https://docs.whylabs.ai/docs/whylabs-capabilities/#access-token-management)
which must be stored in a `whylabs-api-key` Kubernetes secret, described below.

```shell
kubectl create secret generic whylabs-api-key \
--namespace=langkit \
--from-literal=WHYLABS_API_KEY=<whylabs-api-key>
```

* Generate a random value for the `langkit-api-secret` Kubernetes secret, also
described below. **This secret is required to call the container API endpoint**.

```
kubectl create secret generic langkit-api-secret \
--namespace=langkit \
--from-literal=CONTAINER_PASSWORD=<langkit-api-secret>
```

### LangKit Configuration

Review the [langkit-container-examples](https://github.com/whylabs/langkit-container-examples)
repository for information and documentation around custom `LangKit`
configurations.
No LangKit configurations are required out of the box. However, for further customizations,
review the [langkit-container-examples](https://github.com/whylabs/langkit-container-examples)
repository for more details.

## Helm Chart Installation

Expand Down

0 comments on commit 1afb8bf

Please sign in to comment.