Skip to content

Commit 8ba9f12

Browse files
authored
update install instructions (#134)
Signed-off-by: Michael Kalantar <[email protected]>
1 parent 0b006bb commit 8ba9f12

File tree

4 files changed

+23
-8
lines changed

4 files changed

+23
-8
lines changed

docs/getting-started/install.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
1-
```shell
2-
helm upgrade --install --repo https://iter8-tools.github.io/iter8 --version 0.18 iter8 controller \
3-
--set clusterScoped=true
4-
```
1+
Iter8 can be installed and configured to watch resources either in a single namespace (namespace-scoped) or in the whole cluster (cluster-scoped).
2+
3+
=== "Namespace-scoped"
4+
```shell
5+
helm install --repo https://iter8-tools.github.io/iter8 --version 0.18 iter8 controller
6+
```
7+
8+
=== "Cluster-scoped"
9+
```shell
10+
helm install --repo https://iter8-tools.github.io/iter8 --version 0.18 iter8 controller \
11+
--set clusterScoped=true
12+
```
513

614
For additional install options, see [Iter8 Installation](https://iter8.tools/0.18/user-guide/install/).

docs/user-guide/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ template: main.html
44

55
# Install options
66

7-
By default, Iter8 uses [BadgerDB](https://dgraph.io/docs/badger/) to store metrics from A/B/n and performance tests. BadgerDB is not suitable for production use. To install for production, use another database. Database options are listed [here](metrics_store.md).
7+
By default, Iter8 uses [BadgerDB](https://dgraph.io/docs/badger/) to store metrics from A/B/n and performance tests. BadgerDB is not suitable for production use. To install for production, use [Redis](metrics_store.md).
88

99
## Install with `helm`
1010

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,8 @@ nav:
157157
- Slack: tutorials/integrations/slack.md
158158
- User guide:
159159
- Topics:
160-
- Install options: user-guide/install.md
161-
- Uninstall options: user-guide/uninstall.md
160+
- Installation: user-guide/install.md
161+
- Uninstall: user-guide/uninstall.md
162162
- Progressive release:
163163
- About: user-guide/progressive-release/about.md
164164
- Using new resource types: user-guide/progressive-release/extension.md

overrides/home.html

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,14 @@ <h3>
103103
</li>
104104
</ul>
105105
</h3>
106-
</div>
106+
<h3>
107+
<span class="twemoji">
108+
{% include ".icons/material/star.svg" %}
109+
</span>
110+
Use with any Kubernetes resource types including CRDs
111+
</h3>
112+
113+
</div>
107114

108115
<!-- Hero image -->
109116
<div class="mdx-hero__image">

0 commit comments

Comments
 (0)