Skip to content

Commit

Permalink
add other setup and upgrade docs
Browse files Browse the repository at this point in the history
  • Loading branch information
seemywingz committed Jul 30, 2024
1 parent c5b3996 commit 4fa859b
Show file tree
Hide file tree
Showing 14 changed files with 345 additions and 41 deletions.
48 changes: 48 additions & 0 deletions pages/how-to/set-up/controllers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: Setting Up a Controller
description: Using Plural CLI to Deploy a Kubernetes Controller Resources
---

# Prerequisites
[Plural CLI](/how-to/set-up/plural-cli)

#### Ensure Cloud Provider CLI Authentication
**Plural** uses the _default_ profile when deploying resources

AWS
```sh
aws sts get-caller-identity
```
AZ
```sh
az account show
```
GCP
```sh
gcloud auth list
```

#### Ensure your _[app.plural.sh](https://app.plural.sh/profile/me)_ User has `admin` permissions

```sh
plural login
```

# Set Up
Deploy a few basic controllers to that cluster, I'd do ingress-nginx + external-dns

this should include supporting terraform to configure externaldns' IRSA rule on EKS

should be configured as GlobalServices w/ liquid templating for injecting that data in

# Troubleshooting
#### Get Kubeconfig for the MGMT Cluster
```sh
plural wkspace kube-init
```

Use `kubectl` with the newly added kube context
The key namespaces to check are:
* plrl-console
* plrl-deploy-operator
* plrl-runtime
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Using Plural CLI to Deploy a MGMT Kubernetes Cluster
[Plural CLI](/how-to/set-up/plural-cli)

##### Ensure Cloud Provider CLI Authentication
Plural uses the _default_ profile when deploying resources
**Plural** uses the _default_ profile when deploying resources

AWS
```sh
Expand All @@ -26,11 +26,11 @@ gcloud auth list
Ensure your _[app.plural.sh](https://app.plural.sh/profile/me)_ User has `admin` permissions
Follow the onscreen prompts to setup the repo and deploy resources

* The Plural CLI will create a new repository
* The **Plural** CLI will create a new repository in the current directory
* If there are permission related repository creation constraints
the repo can be cloned before running `plural` commands

* Use the provided Plural DNS Services for the MGMT Cluster
* Use the provided **Plural** DNS Services for the MGMT Cluster
* When providing a domain name provide the _canonical_ name, e.g. how-to-plrl.onplural.sh

```sh
Expand Down
50 changes: 50 additions & 0 deletions pages/how-to/set-up/pipelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: Setting Up a Pipeline
description: Using Plural Deploy Pipelines
---

# Prerequisites
[Plural CLI](/how-to/set-up/plural-cli)

#### Ensure Cloud Provider CLI Authentication
**Plural** uses the _default_ profile when deploying resources

AWS
```sh
aws sts get-caller-identity
```
AZ
```sh
az account show
```
GCP
```sh
gcloud auth list
```

#### Ensure your _[app.plural.sh](https://app.plural.sh/profile/me)_ User has `admin` permissions

```sh
plural login
```

# Set Up
Set Up a dev -> staging -> prod pipeline

include creation of the rest of the cluster fleet with stacks

include CRDs

use the prior microservice

# Troubleshooting
#### Get Kubeconfig for the MGMT Cluster
```sh
plural wkspace kube-init
```

Use `kubectl` with the newly added kube context
The key namespaces to check are:
* plrl-console
* plrl-deploy-operator
* plrl-runtime
46 changes: 46 additions & 0 deletions pages/how-to/set-up/pr-automation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Setting Up PR Automation
description: Using Plural CLI to Deploy a Workload Kubernetes Cluster
---

# Prerequisites
[Plural CLI](/how-to/set-up/plural-cli)

#### Ensure Cloud Provider CLI Authentication
**Plural** uses the _default_ profile when deploying resources

AWS
```sh
aws sts get-caller-identity
```
AZ
```sh
az account show
```
GCP
```sh
gcloud auth list
```

#### Ensure your _[app.plural.sh](https://app.plural.sh/profile/me)_ User has `admin` permissions

```sh
plural login
```

# Set Up
Self-service PR automation for common usecases

chose creating a new database with Stacks, write basic terraform setup for db + pr automation to create it w/ a few inputs as a CRD.

# Troubleshooting
#### Get Kubeconfig for the MGMT Cluster
```sh
plural wkspace kube-init
```

Use `kubectl` with the newly added kube context
The key namespaces to check are:
* plrl-console
* plrl-deploy-operator
* plrl-runtime
44 changes: 44 additions & 0 deletions pages/how-to/set-up/workload-cluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Setting Up a Workload Cluster
description: Using Plural CLI to Deploy a Workload Kubernetes Cluster
---

# Prerequisites
[Plural CLI](/how-to/set-up/plural-cli)

#### Ensure Cloud Provider CLI Authentication
**Plural** uses the _default_ profile when deploying resources

AWS
```sh
aws sts get-caller-identity
```
AZ
```sh
az account show
```
GCP
```sh
gcloud auth list
```

#### Ensure your _[app.plural.sh](https://app.plural.sh/profile/me)_ User has `admin` permissions

```sh
plural login
```

# Set Up
Create first workload cluster with Stacks (should use the cluster-creator PR automation from plural up)

# Troubleshooting
#### Get Kubeconfig for the MGMT Cluster
```sh
plural wkspace kube-init
```

Use `kubectl` with the newly added kube context
The key namespaces to check are:
* plrl-console
* plrl-deploy-operator
* plrl-runtime
4 changes: 4 additions & 0 deletions pages/how-to/upgrade/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Upgrading Plural Components
description: Using Plural CLI to Upgrade Resources
---
44 changes: 44 additions & 0 deletions pages/how-to/upgrade/mgmt-cluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Upgrading a MGMT Cluster
description: Using Plural CLI to Upgrade a Management Kubernetes Cluster
---

# Prerequisites
[Plural CLI](/how-to/set-up/plural-cli)

#### Ensure Cloud Provider CLI Authentication
**Plural** uses the _default_ profile when deploying resources

AWS
```sh
aws sts get-caller-identity
```
AZ
```sh
az account show
```
GCP
```sh
gcloud auth list
```

#### Ensure your _[app.plural.sh](https://app.plural.sh/profile/me)_ User has `admin` permissions

```sh
plural login
```

# Set Up
Create first workload cluster with Stacks (should use the cluster-creator PR automation from plural up)

# Troubleshooting
#### Get Kubeconfig for the MGMT Cluster
```sh
plural wkspace kube-init
```

Use `kubectl` with the newly added kube context
The key namespaces to check are:
* plrl-console
* plrl-deploy-operator
* plrl-runtime
28 changes: 28 additions & 0 deletions pages/how-to/upgrade/plural-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Upgrading the Plural CLI
description: Guides for Upgrading the Plural CLI
---

### Install Prerequisites

[Mac Homebrew](https://brew.sh/)
```sh
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew update
```
[AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html), [Helm CLI](https://helm.sh/), [Terraform](https://developer.hashicorp.com/terraform/intro), [kubectl](https://kubernetes.io/docs/reference/kubectl/)
```sh
brew install awscli helm terraform kubectl
```

### Install [Plural CLI](https://github.com/pluralsh/plural-cli/?tab=readme-ov-file#installation)
```sh
brew upgrade pluralsh/plural/plural
```

### Validate Install
```sh
plural login
```


44 changes: 44 additions & 0 deletions pages/how-to/upgrade/workload-cluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Upgrading a Workload Cluster
description: Using Plural CLI to Upgrade a Workload Kubernetes Cluster
---

# Prerequisites
[Plural CLI](/how-to/set-up/plural-cli)

#### Ensure Cloud Provider CLI Authentication
**Plural** uses the _default_ profile when deploying resources

AWS
```sh
aws sts get-caller-identity
```
AZ
```sh
az account show
```
GCP
```sh
gcloud auth list
```

#### Ensure your _[app.plural.sh](https://app.plural.sh/profile/me)_ User has `admin` permissions

```sh
plural login
```

# Set Up
Create first workload cluster with Stacks (should use the cluster-creator PR automation from plural up)

# Troubleshooting
#### Get Kubeconfig for the MGMT Cluster
```sh
plural wkspace kube-init
```

Use `kubectl` with the newly added kube context
The key namespaces to check are:
* plrl-console
* plrl-deploy-operator
* plrl-runtime
4 changes: 0 additions & 4 deletions pages/how-to/use/index.md

This file was deleted.

4 changes: 0 additions & 4 deletions pages/how-to/use/plural-api.md

This file was deleted.

4 changes: 0 additions & 4 deletions pages/how-to/use/plural-console.md

This file was deleted.

4 changes: 0 additions & 4 deletions pages/how-to/use/plural-docs.md

This file was deleted.

Loading

0 comments on commit 4fa859b

Please sign in to comment.