Skip to content

Docs/config #16

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 4 commits into from
May 30, 2020
Merged

Docs/config #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cc0301b
fix incorrect field
rushtehrani May 29, 2020
83981a4
remove email and commonName
rushtehrani May 29, 2020
3ecac3e
add eks credentials reference
rushtehrani May 30, 2020
603416d
update README.md
rushtehrani May 30, 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
13 changes: 3 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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=<Your GitHub username> npm deploy
$ GIT_USER=<Your GitHub username> 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.
4 changes: 1 addition & 3 deletions docs/deployment/configuration/tls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,11 +180,9 @@ 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
data: >
serviceAccountKey: |
{
"type": "service_account",
"project_id": "my-project-id",
Expand Down
4 changes: 4 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 @@ -43,6 +43,10 @@ The `eksctl` command above will automatically retrieve your cluster's access cre
eksctl utils write-kubeconfig --cluster=<cluster-name> --region <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).

Expand Down