diff --git a/docs/deployment/public/aks.md b/docs/deployment/public/aks.md index f9496fce..8e434185 100644 --- a/docs/deployment/public/aks.md +++ b/docs/deployment/public/aks.md @@ -80,6 +80,7 @@ az aks get-credentials --resource-group --name - values={[ { label: 'Linux', value: 'linux', }, { label: 'macOS', value: 'macos', }, + { label: 'Windows', value: 'windows', }, ] }> @@ -116,6 +117,14 @@ opctl version ``` + + +:::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. +::: + + + 2. Run the following command to initialize a `params.yaml` template for AKS: diff --git a/docs/deployment/public/eks.md b/docs/deployment/public/eks.md index 8001c99e..1b75bb9f 100644 --- a/docs/deployment/public/eks.md +++ b/docs/deployment/public/eks.md @@ -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', }, ] }> @@ -90,6 +91,13 @@ mv ./opctl-macos-amd64 /usr/local/bin/opctl opctl version ``` + + + +:::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. +::: + diff --git a/docs/deployment/public/gke.md b/docs/deployment/public/gke.md index 3d3f087c..23b41fbf 100644 --- a/docs/deployment/public/gke.md +++ b/docs/deployment/public/gke.md @@ -51,6 +51,7 @@ gcloud container clusters get-credentials --zone values={[ { label: 'Linux', value: 'linux', }, { label: 'macOS', value: 'macos', }, + { label: 'Windows', value: 'windows', }, ] }> @@ -86,6 +87,13 @@ mv ./opctl-macos-amd64 /usr/local/bin/opctl opctl version ``` + + + +:::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. +::: + diff --git a/docs/deployment/upgrade/overview.md b/docs/deployment/upgrade/overview.md new file mode 100644 index 00000000..46466820 --- /dev/null +++ b/docs/deployment/upgrade/overview.md @@ -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). +::: \ No newline at end of file diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md index 97c66baa..9eacbb8f 100644 --- a/docs/getting-started/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -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 Next, create a Kubernetes cluster in one of the following cloud providers: --zone -## 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). @@ -120,13 +121,14 @@ gcloud container clusters get-credentials --zone values={[ { label: 'Linux', value: 'linux', }, { label: 'macOS', value: 'macos', }, + { label: 'Windows', value: 'windows', }, ] }> ```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 @@ -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 @@ -155,6 +157,13 @@ mv ./opctl-macos-amd64 /usr/local/bin/opctl opctl version ``` + + + +:::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. +::: + @@ -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. diff --git a/docusaurus.config.js b/docusaurus.config.js index 0fe839a4..9f4e283b 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -8,7 +8,6 @@ module.exports = { projectName: 'core-docs', // Usually your repo name. themeConfig: { disableDarkMode: true, - sidebarCollapsible: false, navbar: { title: '', logo: { diff --git a/sidebars.js b/sidebars.js index 3014f50a..0c9ad028 100644 --- a/sidebars.js +++ b/sidebars.js @@ -43,7 +43,7 @@ module.exports = { items: [ { type: 'category', - label: 'Image/video auto annotation', + label: 'Auto annotation with CVAT', items: [ { type: 'doc', @@ -91,6 +91,10 @@ module.exports = { 'deployment/configuration/tls', ] }, + { + type: 'doc', + id: 'deployment/upgrade/overview' + }, { type: 'doc', id: 'deployment/troubleshooting/overview' diff --git a/src/css/custom.css b/src/css/custom.css index 9b460e4b..7e82f0f6 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -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; @@ -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; @@ -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; diff --git a/static/img/favicon.png b/static/img/favicon.png index a5616e5c..08d15aad 100644 Binary files a/static/img/favicon.png and b/static/img/favicon.png differ