From cc0301b183122ca56c177c8c5903a7441a343f90 Mon Sep 17 00:00:00 2001 From: rushtehrani Date: Fri, 29 May 2020 16:33:07 -0700 Subject: [PATCH 1/4] fix incorrect field --- docs/deployment/configuration/tls.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deployment/configuration/tls.md b/docs/deployment/configuration/tls.md index 4f4f2014..4623961b 100644 --- a/docs/deployment/configuration/tls.md +++ b/docs/deployment/configuration/tls.md @@ -184,7 +184,7 @@ certManager: email: admin@example.com clouddns: projectId: my-project-id - data: > + serviceAccountKey: | { "type": "service_account", "project_id": "my-project-id", From 83981a4ffbd9fe249cbe3bdcc676ec42e4f9647a Mon Sep 17 00:00:00 2001 From: rushtehrani Date: Fri, 29 May 2020 16:47:08 -0700 Subject: [PATCH 2/4] remove email and commonName --- docs/deployment/configuration/tls.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/deployment/configuration/tls.md b/docs/deployment/configuration/tls.md index 4623961b..0edc61b4 100644 --- a/docs/deployment/configuration/tls.md +++ b/docs/deployment/configuration/tls.md @@ -180,8 +180,6 @@ Paste them into your `params.yaml`, so you should have something like this ```yaml certManager: - commonName: *.example.com - email: admin@example.com clouddns: projectId: my-project-id serviceAccountKey: | From 3ecac3e4fa610bb2108a30ea7e16ad96313a1b3a Mon Sep 17 00:00:00 2001 From: rushtehrani Date: Fri, 29 May 2020 17:16:38 -0700 Subject: [PATCH 3/4] add eks credentials reference --- docs/deployment/public/eks.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/deployment/public/eks.md b/docs/deployment/public/eks.md index 0d6c07be..bc8acb68 100644 --- a/docs/deployment/public/eks.md +++ b/docs/deployment/public/eks.md @@ -43,6 +43,10 @@ The `eksctl` command above will automatically retrieve your cluster's access cre eksctl utils write-kubeconfig --cluster= --region ``` +:::note +If you are not the person that created the cluster, you will need to be [added to the cluster](https://docs.aws.amazon.com/eks/latest/userguide/add-user-role.html) before you can use `kubectl` with these credentials. +::: + ## Install Onepanel 1. Download the latest `opctl` for your operating system from [our release page](https://github.com/onepanelio/core/releases/latest). From 603416d2d4fa974c7db817a40411e0444b9943b0 Mon Sep 17 00:00:00 2001 From: rushtehrani Date: Fri, 29 May 2020 17:17:48 -0700 Subject: [PATCH 4/4] update README.md --- README.md | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 62541787..26af0940 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Website +# Onepanel Documentation -This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. +This documentation site is built using [Docusaurus 2](https://v2.docusaurus.io/). ### Installation @@ -16,18 +16,11 @@ $ npm start This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server. -### Build - -``` -$ npm build -``` - -This command generates static content into the `build` directory and can be served using any static contents hosting service. ### Deployment ``` -$ GIT_USER= npm deploy +$ GIT_USER= npm run deploy ``` If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.