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

Add HelmCluster docs #66

Open
wants to merge 3 commits into
base: gh-pages
Choose a base branch
from
Open
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
13 changes: 10 additions & 3 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,20 @@ $ helm repo update
{{ latest_chart.description }}

```console
$ helm install {{ site.repo_name }}/{{ latest_chart.name }} --name myrelease --version {{ latest_chart.version }}
$ helm install myrelease {{ site.repo_name }}/{{ latest_chart.name }} --version {{ latest_chart.version }}
```

| Chart Version | App Version | Date |
| ------------- | ----------- | ---- |
You can then use the `HelmCluster` cluster manager in [dask-kubernetes](https://kubernetes.dask.org/en/latest/) to manage scaling form your Python session.

```python
from dask_kubernetes import HelmCluster

cluster = HelmCluster(release_name="myrelease")
cluster.scale(10)
```
Copy link
Collaborator

@consideRatio consideRatio Nov 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is aimed at the dask helm chart rather than daskhub, right? It would be good if that is clarified as this area seems like a chart neutral documentation area of this document.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point thanks! This PR was raised before daskhub was added.


| Chart Version | App Version | Date |
| ------------- | ----------- | ---- |
{% for chart in all_charts -%}
{% unless chart.version contains "-" -%}
| [{{ chart.name }}-{{ chart.version }}]({{ chart.urls[0] }}) | {{ chart.appVersion }} | {{ chart.created | date_to_rfc822 }} |
Expand Down