Skip to content

docs: add upgrading docs #29

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

Merged
merged 11 commits into from
Jun 9, 2020
Merged

docs: add upgrading docs #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
245bc72
add upgrading docs
rushtehrani Jun 9, 2020
66baae6
style: update favicon
rushtehrani Jun 9, 2020
9b03bfd
add windows cli instruction
rushtehrani Jun 9, 2020
fbee21b
update text
rushtehrani Jun 9, 2020
89ed06d
windows instructions
rushtehrani Jun 9, 2020
34af6df
add Windows CLI instructions
rushtehrani Jun 9, 2020
835cad4
collapsible sidebar
rushtehrani Jun 9, 2020
8487753
use double colon for pseudo-elemenet
rushtehrani Jun 9, 2020
5f5e310
fix hovers
rushtehrani Jun 9, 2020
cd8f5d4
fix Codacy review issues
rushtehrani Jun 9, 2020
d8a8ddf
fix Codacy review issues
rushtehrani Jun 9, 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
9 changes: 9 additions & 0 deletions docs/deployment/public/aks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ az aks get-credentials --resource-group <resource-group> --name <cluster-name> -
values={[
{ label: 'Linux', value: 'linux', },
{ label: 'macOS', value: 'macos', },
{ label: 'Windows', value: 'windows', },
]
}>
<TabItem value="linux">
Expand Down Expand Up @@ -116,6 +117,14 @@ opctl version
```

</TabItem>
<TabItem value="windows">

:::info
Download the [attached executable](https://github.com/onepanelio/core/releases/latest/download/opctl-windows-amd64.exe), rename it to `opctl` and move it to a folder that is in your PATH environment variable.
:::

</TabItem>

</Tabs>

2. Run the following command to initialize a `params.yaml` template for AKS:
Expand Down
8 changes: 8 additions & 0 deletions docs/deployment/public/eks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ If you are not the person that created the cluster, you will need to be [added t
values={[
{ label: 'Linux', value: 'linux', },
{ label: 'macOS', value: 'macos', },
{ label: 'Windows', value: 'windows', },
]
}>
<TabItem value="linux">
Expand Down Expand Up @@ -90,6 +91,13 @@ mv ./opctl-macos-amd64 /usr/local/bin/opctl
opctl version
```

</TabItem>
<TabItem value="windows">

:::info
Download the [attached executable](https://github.com/onepanelio/core/releases/latest/download/opctl-windows-amd64.exe), rename it to `opctl` and move it to a folder that is in your PATH environment variable.
:::

</TabItem>
</Tabs>

Expand Down
8 changes: 8 additions & 0 deletions docs/deployment/public/gke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ gcloud container clusters get-credentials <cluster-name> --zone <zone>
values={[
{ label: 'Linux', value: 'linux', },
{ label: 'macOS', value: 'macos', },
{ label: 'Windows', value: 'windows', },
]
}>
<TabItem value="linux">
Expand Down Expand Up @@ -86,6 +87,13 @@ mv ./opctl-macos-amd64 /usr/local/bin/opctl
opctl version
```

</TabItem>
<TabItem value="windows">

:::info
Download the [attached executable](https://github.com/onepanelio/core/releases/latest/download/opctl-windows-amd64.exe), rename it to `opctl` and move it to a folder that is in your PATH environment variable.
:::

</TabItem>
</Tabs>

Expand Down
81 changes: 81 additions & 0 deletions docs/deployment/upgrade/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
title: Adding or upgrading components
sidebar_label: Upgrading
---

Before adding features or upgrading your cluster, we highly recommend you back up your `params.yaml` file. You can optionally commit it into a private repository and encrypt it with [BlackBox](https://github.com/StackExchange/blackbox) or similar tools.

:::tip
We also highly recommend to try these steps on a copy of the production cluster first.
:::

## Adding components
To add additional features to Onepanel:

1. Run `opctl init` with additional flags. For example if you initially ran:

```bash
opctl init --provider gke
```

You can enable https and cert-manager by running:

```bash
opctl init --provider gke --enable-https --enabl-cert-manager --dns-provider clouddns
```

2. Review your `params.yaml` file and complete the new fields accordingly.

:::tip
See [configuration files](/docs/deployment/configuration/files) for additional information.
:::

3. Apply your changes:

```bash
opctl apply
```

:::note
If the application is not loading after these updates, visit our [Troubleshooting](/docs/deployment/troubleshooting/overview) page for some steps that can help resolve most issues. If you are still having issues, join our [Slack community](https://join.slack.com/t/onepanel-ce/shared_invite/zt-eyjnwec0-nLaHhjif9Y~gA05KuX6AUg) or open an issue in [GitHub](https://github.com/onepanelio/core/issues).
:::


## Upgrading components
When upgrading Onepanel, it is best to upgrade one minor version at a time (e.g. 0.9.0 => 0.10.0).

To upgrade Onepanel:

1. Check the current version of `opctl`:

```bash {3}
opctl version

CLI version: 0.10.0
Manifest version: v0.10.0
API version: v0.10.0
Web UI version: v0.10.0

```

2. Download the next version up of `opctl` for your operating system from [our release page](https://github.com/onepanelio/core/releases).

3. Run `opctl init` with the initial flags you used, for example:

```bash
opctl init --provider gke
```

:::important
Run `opctl init` only with the initial flags, you can add additional flags after the upgrade completes.
:::

4. Apply your changes:

```bash
opctl apply
```

:::note
If the application is not loading after these updates, visit our [Troubleshooting](/docs/deployment/troubleshooting/overview) page for some steps that can help resolve most issues. If you are still having issues, join our [Slack community](https://join.slack.com/t/onepanel-ce/shared_invite/zt-eyjnwec0-nLaHhjif9Y~gA05KuX6AUg) or open an issue in [GitHub](https://github.com/onepanelio/core/issues).
:::
25 changes: 17 additions & 8 deletions docs/getting-started/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ import TabItem from '@theme/TabItem';
It's easy to get started with Onepanel. First, you install the CLI (`opctl`) and then using `opctl`, you generate a `params.yaml` file and update it to configure your deployment. Once complete, you can access your deployment from any browser using your Kubernetes authentication token. Finally, you can run a Workflow or create a Workspace.

:::important
The steps in the Quick start allow you to quickly setup a Onepanel cluster for testing. To setup a production cluster with TLS and auto scaling enabled see [instructions for your cloud provider](/docs/deployment/overview#installing-on-public-cloud)
The steps in the Quick start allow you to quickly setup a Onepanel cluster for testing. To setup a production cluster with TLS and auto scaling enabled see [instructions for your cloud provider](/docs/deployment/overview#installing-on-public-cloud).

You can also [add components](/docs/deployment/upgrade/overview) at later time to make this cluster production ready.
:::

## Step 0: Understand the concepts
First, take a look at [concepts](/docs/getting-started/concepts/namespaces) to understand the different components in Onepanel.
Before getting started, take a look at [concepts](/docs/getting-started/concepts/namespaces) to understand the different components in Onepanel.

## Step 1: Create a Kubernetes cluster
## Step 0: Create a Kubernetes cluster
Copy link
Contributor

@aleksandrmelnikov aleksandrmelnikov Jun 9, 2020

Choose a reason for hiding this comment

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

@rushtehrani What about including the way to set the azure cluster kubernetes version?

 --kubernetes-version 1.12.6

Copy link
Contributor Author

@rushtehrani rushtehrani Jun 9, 2020

Choose a reason for hiding this comment

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

Trying to keep the instructions minimal for the quick start, but adding it to the AKS deployment instructions makes perfect sense which I see you've already done.

Copy link
Contributor

@aleksandrmelnikov aleksandrmelnikov Jun 9, 2020

Choose a reason for hiding this comment

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

Minimal makes sense. Not a blocker by any means.

Next, create a Kubernetes cluster in one of the following cloud providers:

<Tabs
Expand Down Expand Up @@ -111,7 +112,7 @@ gcloud container clusters get-credentials <cluster-name> --zone <zone>
</TabItem>
</Tabs>

## Step 2: Install Onepanel
## Step 1: Install Onepanel

1. Download the latest `opctl` for your operating system from [our release page](https://github.com/onepanelio/core/releases/latest).

Expand All @@ -120,13 +121,14 @@ gcloud container clusters get-credentials <cluster-name> --zone <zone>
values={[
{ label: 'Linux', value: 'linux', },
{ label: 'macOS', value: 'macos', },
{ label: 'Windows', value: 'windows', },
]
}>
<TabItem value="linux">

```bash
# Download the binary
curl -sLO https://github.com/onepanelio/core/releases/download/latest/opctl-linux-amd64
curl -sLO https://github.com/onepanelio/core/releases/latest/download/opctl-linux-amd64

# Make binary executable
chmod +x opctl-linux-amd64
Expand All @@ -143,7 +145,7 @@ opctl version

```bash
# Download the binary
curl -sLO https://github.com/onepanelio/core/releases/download/latest/opctl-macos-amd64
curl -sLO https://github.com/onepanelio/core/releases/latest/download/opctl-macos-amd64

# Make binary executable
chmod +x opctl-macos-amd64
Expand All @@ -155,6 +157,13 @@ mv ./opctl-macos-amd64 /usr/local/bin/opctl
opctl version
```

</TabItem>
<TabItem value="windows">

:::info
Download the [attached executable](https://github.com/onepanelio/core/releases/latest/download/opctl-windows-amd64.exe), rename it to `opctl` and move it to a folder that is in your PATH environment variable.
:::

</TabItem>
</Tabs>

Expand Down Expand Up @@ -227,7 +236,7 @@ If the application is not loading, visit our [Troubleshooting](/docs/deployment/
opctl auth token
```

## Step 3: Create a simple Workflow
## Step 2: Create a simple Workflow
Let's first create a simple Directed Acyclic Graph (DAG) Workflow Template:

1. Click **Workflows** in the top menu.
Expand Down
1 change: 0 additions & 1 deletion docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ module.exports = {
projectName: 'core-docs', // Usually your repo name.
themeConfig: {
disableDarkMode: true,
sidebarCollapsible: false,
navbar: {
title: '',
logo: {
Expand Down
6 changes: 5 additions & 1 deletion sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ module.exports = {
items: [
{
type: 'category',
label: 'Image/video auto annotation',
label: 'Auto annotation with CVAT',
items: [
{
type: 'doc',
Expand Down Expand Up @@ -91,6 +91,10 @@ module.exports = {
'deployment/configuration/tls',
]
},
{
type: 'doc',
id: 'deployment/upgrade/overview'
},
{
type: 'doc',
id: 'deployment/troubleshooting/overview'
Expand Down
40 changes: 32 additions & 8 deletions src/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,29 @@
--ifm-navbar-link-hover-color: var(--ifm-color-secondary-lightest);
--ifm-heading-color: var(--ifm-color-primary-darker);
--ifm-font-size-base: 16px;
--ifm-list-left-padding: 1.25rem;
--ifm-navbar-link-hover-color: rgb(255, 255, 255);
--ifm-navbar-link-color: rgb(255, 255, 255, 0.8);
}

ol > li::marker {
font-weight: bold;
}

.menu__link--sublist::after {
background-size: 1.25rem 1.25rem;
}

.header-icon-link {
padding: 8px;
opacity: 0.8;
}

.header-github-link:hover {
opacity: 0.6;
.header-icon-link:hover {
opacity: 1;
}

.header-github-link:before {
.header-github-link::before {
content: '';
width: 24px;
height: 24px;
Expand All @@ -37,11 +49,7 @@
no-repeat;
}

.header-slack-link:hover {
opacity: 0.6;
}

.header-slack-link:before {
.header-slack-link::before {
content: '';
width: 24px;
height: 24px;
Expand Down Expand Up @@ -211,6 +219,22 @@
fill: #f1c40f;
}

.admonition-info {
background-color: transparent;
border-left: 8px solid;
border-color: var(--ifm-toc-border-color);
color: var(--ra-color-text-dark);
}

.admonition-info h5 {
color: var(--ifm-toc-border-color);
}

.admonition-info .admonition-icon svg {
stroke: var(--ifm-toc-border-color);
fill: var(--ifm-toc-border-color);
}

.integrations.grid-container {
display: grid;
grid-template-columns: auto auto auto auto;
Expand Down
Binary file modified static/img/favicon.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.