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.

Sign up for GitHub

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

Jump to bottom

docs: Quick start updates #54

Merged
merged 3 commits into from
Aug 19, 2020
Merged

docs: Quick start updates #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d8cb74f
update artifact repository information
rushtehrani Aug 15, 2020
8638584
move artifact-repository-provider flag info up
rushtehrani Aug 15, 2020
a2d472a
note additional flags in quick start
rushtehrani Aug 15, 2020
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
12 changes: 9 additions & 3 deletions docs/deployment/configuration/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@ opctl init --provider <provider-name>

Available provider options are: `aks`, `eks` and `gke` for public cloud installations and `minikube`, `microk8s` for local installations.

To use an artifact repository other than `s3` use the `--artifact-repository-provider` flag:

```bash
opctl init --provider <provider-name> \
--artifact-repository-provider <object-storage-provider>
```

Available options for `--artifact-repository-provider` are `s3` and `gcs`.

HTTPS is not enabled by default, to enable HTTPS but manage the TLS certificate yourself:

```bash
Expand All @@ -35,9 +44,6 @@ opctl init --provider <provider-name> \
Refer to [TLS certificates](/docs/deployment/configuration/tls) section for more information and a list of supported DNS providers.
:::

To set the artifact repository provider, use the `--artifact-repository-provider s3` flag.
- Default is `s3`
- Supported values are `s3`, `gcs`

To add ElasticSearch, Fluentd, and Kibana (EFK) logging, add the `--enable-logging` flag.

Expand Down
26 changes: 22 additions & 4 deletions docs/getting-started/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,13 +319,21 @@ Download the [attached executable](https:/onepanelio/core/releases/l
opctl init --provider aks
```

:::note
If you have GPU nodes, you need to set the `--gpu-device-plugins` flag. Valid values are `nvidia` and `amd` or a comma separated combination of both `nvidia,amd`.
:::

</TabItem>
<TabItem value="eks">

```bash
opctl init --provider eks
```

:::note
If you have GPU nodes, you need to set the `--gpu-device-plugins` flag. Valid values are `nvidia` and `amd` or a comma separated combination of both `nvidia,amd`.
:::

</TabItem>
<TabItem value="gke">

Expand All @@ -348,6 +356,10 @@ opctl init --provider minikube --enable-metallb
```
:::

:::note
If you have GPU nodes, you need to set the `--gpu-device-plugins` flag. Valid values are `nvidia` and `amd` or a comma separated combination of both `nvidia,amd`.
:::

</TabItem>

<TabItem value="microk8s">
Expand All @@ -363,15 +375,21 @@ opctl init --provider microk8s --enable-metallb
```
:::

:::note
If you have GPU nodes, you need to set the `--gpu-device-plugins` flag. Valid values are `nvidia` and `amd` or a comma separated combination of both `nvidia,amd`.
:::

</TabItem>
</Tabs>

3. Populate `params.yaml` by following the instructions in the template, you can also refer to [configuration file sections](/docs/deployment/configuration/files#sections) for more detailed information.
:::important
You can use different object storage than S3 by setting the `--artifact-repository-provider` flag.

:::note
See [configuration metallb](/docs/deployment/configuration/files#metal-lb) for metallb specific details.
See [CLI overview](/docs/deployment/configuration/cli) for additional flags that that may apply.
:::

3. Populate `params.yaml` by following the instructions in the template, you can also refer to [configuration file sections](/docs/deployment/configuration/files#sections) for more detailed information.

4. Finally, run the following command to deploy Onepanel to your cluster:

<Tabs
Expand Down Expand Up @@ -550,7 +568,7 @@ istio-ingressgateway LoadBalancer 10.152.183.166 10.1.31.0 15020:31979

Inside the multipass VM, add an entry to the `/etc/hosts` file using the EXTERNAL-IP from above.
```shell script
sudo nano /etc/hosts
sudo nano /etc/hosts
```

```text
Expand Down