Skip to content
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

Jump to bottom

Update AWS Integration page to include cloud-provider and k8s-storage #763

Merged
merged 7 commits into from
Apr 18, 2023
Merged

Update AWS Integration page to include cloud-provider and k8s-storage #763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b83594e
Update AWS Integration page to include cloud-provider and k8s-storage
addyess Apr 11, 2023
c6fbf33
Update docs for gcp storage
addyess Apr 12, 2023
85f5935
updates azure integration page
addyess Apr 12, 2023
efafca7
Merge branch 'main' of github.com:charmed-kubernetes/kubernetes-docs …
addyess Apr 12, 2023
19217dd
updates vsphere integration page
addyess Apr 12, 2023
b76e9ea
Update aws-integration.md
evilnick Apr 14, 2023
1cc9a88
Update aws-integration.md
evilnick Apr 18, 2023
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
118 changes: 104 additions & 14 deletions pages/k8s/aws-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ toc: False
---

**Charmed Kubernetes** will run seamlessly on AWS. With the addition of the
`aws-integrator`, your cluster will also be able to directly use AWS native
features.
`aws-integrator` and its companion charms, your cluster will also be able
to directly use AWS native features.


## AWS integrator
Expand All @@ -25,31 +25,89 @@ AWS. Using the credentials provided to **Juju**, it acts as a proxy between
Charmed Kubernetes and the underlying cloud, granting permissions to
dynamically create, for example, EBS volumes.

## AWS K8S Storage

The `aws-k8s-storage` charm moves the AWS specific functions of the EBS csi-driver
out-of-tree. Using this charm, the drivers are installed as workloads in the Kubernetes
cluster instead of as natural code paths of the Kubernetes binaries.

## AWS Cloud Provider

The `aws-cloud-provider` moves the AWS specific functions of the cloud-provider
out-of-tree. The AWS cloud provider provides the interface between a Kubernetes cluster
and AWS service APIs. This project allows a Kubernetes cluster to provision,
monitor and remove AWS resources necessary for operation of the cluster.

### Version support

#### From Kubernetes 1.27

The in-tree cloud-provider is no longer available, and must be deployed
as container workloads in the cluster. Charmed Kubernetes recommends
using the `aws-cloud-provider` charm to access AWS Service APIs.

#### Prior to Kubernetes 1.27

The in-tree cloud-provider is natively available in Kubernetes until the 1.27
release, and it is not necessary to deploy the `aws-cloud-provider` charm as in the
above overlay.


### Installing

If you install **Charmed Kubernetes** [using the Juju bundle][install], you can add the
aws-integrator at the same time by using the following overlay file ([download
aws-integrator at the same time by using the following cloud-provider overlay file ([download
it here][asset-aws-overlay]):

```yaml
description: Charmed Kubernetes overlay to add native AWS support.
applications:
aws-integrator:
annotations:
gui-x: "600"
gui-y: "300"
charm: aws-integrator
num_units: 1
trust: true
aws-cloud-provider:
charm: aws-cloud-provider
relations:
- ['aws-integrator', 'kubernetes-control-plane']
- ['aws-integrator', 'kubernetes-worker']
```
- ["aws-cloud-provider:certificates", "easyrsa"]
- ["aws-cloud-provider:kube-control", "kubernetes-control-plane"]
- ["aws-cloud-provider:external-cloud-provider", "kubernetes-control-plane"]
- ["aws-cloud-provider:aws-integration", "aws-integrator"]
```

To use this overlay with the **Charmed Kubernetes** bundle, it is specified during deploy like this:
As well as the storage overlay file ([download it here][asset-aws-storage-overlay]):

```yaml
description: Charmed Kubernetes overlay to add native AWS support.
applications:
kubernetes-control-plane:
options:
allow-privileged: "true"
aws-integrator:
charm: aws-integrator
num_units: 1
trust: true
aws-k8s-storage:
charm: aws-k8s-storage
trust: true
options:
image-registry: public.ecr.aws
relations:
- ['aws-k8s-storage:certificates', 'easyrsa:client']
- ['aws-k8s-storage:kube-control', 'kubernetes-control-plane:kube-control']
- ['aws-k8s-storage:aws-integration', 'aws-integrator:aws']
# Include the following relations if not using the aws-cloud-provider charm
# - ['aws-integrator', 'kubernetes-control-plane']
# - ['aws-integrator', 'kubernetes-worker']
```

To use these overlays with the **Charmed Kubernetes** bundle, it is specified
during deploy like this:

```bash
juju deploy charmed-kubernetes --overlay ~/path/aws-overlay.yaml --trust
juju deploy charmed-kubernetes --overlay ~/path/aws-overlay.yaml --overlay ~/path/aws-storage-overlay.yaml --trust
```

... and remember to fetch the configuration file!
Expand All @@ -63,15 +121,39 @@ please see the [charm readme][aws-integrator-readme].

### Using EBS volumes

Many pods you may wish to deploy will require storage. Although you can use
Many pods you may wish to deploy will require storage. Although you can use
any type of storage supported by Kubernetes (see the
[storage documentation][storage]), you also have the option to use the native
AWS storage, Elastic Block Store (EBS).

#### Beginning in Kubernetes 1.25

The `aws-k8s-storage` charm will need to be installed to make use of EBS Volumes.
Amazon removed CSIMigration away from the in-tree binaries but made them available
as container workload in the cluster. This charm installs and relates to the
existing integrator charm.

A StorageClass will be created by this charm named `csi-aws-ebs-default`

You can confirm this has been added by running:

```bash
kubectl get sc
```

which should return:
```bash
NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE
csi-aws-ebs-default ebs.csi.aws.com Delete WaitForFirstConsumer false 9s
```

#### Prior to Kubernetes 1.25

First we need to create a storage class which can be used by Kubernetes.
To start with, we will create one for the 'General Purpose SSD' type of EBS
storage:


```bash
kubectl create -f - <<EOY
apiVersion: storage.k8s.io/v1
Expand Down Expand Up @@ -101,6 +183,8 @@ needed, simply give them a different name and replace the 'type: gp2' with a
different type (See the [AWS website][ebs-info] for more information on the
available types).

#### Creating a PVC

To actually create storage using this new class, you can make a Persistent Volume Claim:

```bash
Expand Down Expand Up @@ -243,15 +327,20 @@ Hello Kubernetes!
</div>
</div>

### Upgrading the integrator-charm
### Upgrading the charms

The aws-integrator is not specifically tied to the version of Charmed Kubernetes installed and may
generally be upgraded at any time with the following command:
The charm `aws-integrator`, `aws-cloud-provider` and `aws-k8s-storage`
can be refreshed within the current charm channel without concern and
can be upgraded at any time with the following command,

```bash
juju refresh aws-integrator
juju refresh aws-cloud-provider
juju refresh aws-k8s-storage
```

It isn't recommended to switch charm channels unless a full charm upgrade is planned.

### Troubleshooting

If you have any specific problems with the aws-integrator, you can report bugs on
Expand All @@ -276,6 +365,7 @@ If you are an AWS user, you may also be interested in how to
<!-- LINKS -->

[asset-aws-overlay]: https://raw.githubusercontent.com/charmed-kubernetes/bundle/main/overlays/aws-overlay.yaml
[asset-aws-storage-overlay]: https://raw.githubusercontent.com/charmed-kubernetes/bundle/main/overlays/aws-stroage-overlay.yaml
[quickstart]: /kubernetes/docs/quickstart
[storage]: /kubernetes/docs/storage
[ebs-info]: https://aws.amazon.com/ebs/features/
Expand All @@ -293,4 +383,4 @@ If you are an AWS user, you may also be interested in how to
or
<a href="https://github.com/charmed-kubernetes/kubernetes-docs/issues/new" >file a bug here</a>.</p>
</div>
</div>
</div>
23 changes: 14 additions & 9 deletions pages/k8s/azure-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ dynamically create, for example, storage.
### Installing using the Out-of-Tree Providers

If you install **Charmed Kubernetes** [using the Juju bundle][install],
you can add the azure-cloud-provider at the same time by using the following
you can add the `azure-cloud-provider` charm at the same time by using the following
overlay file ([download it here][asset-azure-cloud-overlay]):

```yaml
Expand All @@ -46,14 +46,10 @@ applications:
charm: azure-cloud-provider

relations:
- - azure-cloud-provider:certificates
- easyrsa:client # or whichever application supplies cluster certs
- - azure-cloud-provider:kube-control
- kubernetes-control-plane:kube-control
- - azure-cloud-provider:external-cloud-provider
- kubernetes-control-plane:external-cloud-provider
- - azure-cloud-provider:azure-integration
- azure-integrator:clients
- [ 'azure-cloud-provider:certificates', 'easyrsa:client' ] # or whichever application supplies cluster certs
- [ 'azure-cloud-provider:kube-control', 'kubernetes-control-plane:kube-control' ]
- [ 'azure-cloud-provider:azure-integration', 'azure-integrator:clients' ]
- [ 'azure-cloud-provider:external-cloud-provider', 'kubernetes-control-plane:external-cloud-provider' ]
```

To use this overlay with the **Charmed Kubernetes** bundle, it is specified
Expand All @@ -63,6 +59,15 @@ during deploy like this:
juju deploy charmed-kubernetes --overlay azure-cloud-overlay.yaml --trust
```

... and remember to fetch the configuration file!

```bash
juju ssh kubernetes-control-plane/leader -- cat config > ~/.kube/config
```

For more configuration options and details of the permissions which the
integrator uses, please see the [charm readme][azure-integrator].

### Installing using In-Tree Providers

The Kubernetes binaries have in-tree providers for common cloud platforms,
Expand Down
79 changes: 70 additions & 9 deletions pages/k8s/gcp-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,13 @@ GCP. Using the credentials provided to Juju, it acts as a proxy between
**Charmed Kubernetes** and the underlying cloud, granting permissions to
dynamically create, for example, storage volumes.

## GCP K8S Storage

The `gcp-k8s-storage` charm moves the GCP specific functions of the PD csi-driver
out-of-tree. Using this charm, the drivers are installed as workloads in the kubernetes
cluster instead of as natural code paths of the kubernetes binaries.


### Installing

If you install **Charmed Kubernetes** [using the Juju bundle][install], you can add the
Expand All @@ -55,9 +62,6 @@ it here][asset-gcp-overlay]):
description: Charmed Kubernetes overlay to add native GCP support.
applications:
gcp-integrator:
annotations:
gui-x: "600"
gui-y: "300"
charm: gcp-integrator
num_units: 1
trust: true
Expand All @@ -66,11 +70,34 @@ relations:
- ['gcp-integrator', 'kubernetes-worker']
```

To use this overlay with the **Charmed Kubernetes** bundle, it is specified
As well as the storage overlay file ([download it here][asset-gcp-storage-overlay]):

```yaml
description: Charmed Kubernetes overlay to add native GCP storage support.
applications:
kubernetes-control-plane:
options:
allow-privileged: "true"
gcp-integrator:
charm: gcp-integrator
num_units: 1
trust: true
gcp-k8s-storage:
charm: gcp-k8s-storage
trust: true
options:
image-registry: k8s.gcr.io
relations:
- ['gcp-k8s-storage:certificates', 'easyrsa:client']
- ['gcp-k8s-storage:kube-control', 'kubernetes-control-plane:kube-control']
- ['gcp-k8s-storage:gcp-integration', 'gcp-integrator:gcp']
```

To use these overlays with the **Charmed Kubernetes** bundle, it is specified
during deploy like this:

```bash
juju deploy charmed-kubernetes --overlay ~/path/gcp-overlay.yaml --trust
juju deploy charmed-kubernetes --overlay ~/path/gcp-overlay.yaml --overlay ~/path/gcp-storage-overlay.yaml --trust
```

... and remember to fetch the configuration file!
Expand All @@ -93,6 +120,33 @@ GCP storage currently comes in two types - SSD (pd-ssd) or
'standard'(pd-standard). To use these, we need to create a storage classes in
Kubernetes.

#### Beginning in Kubernetes 1.25

The `gcp-k8s-storage` charm will need to be installed to make use of PD Volumes.
Google removed CSIMigration away from the in-tree binaries but made them available
as container workload in the cluster. This charm installs and relates to the
existing integrator charm.

A StorageClass will be created by this charm named `csi-gce-pd-default`

You can confirm this has been added by running:

```bash
kubectl get sc
```

which should return:
```bash
NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE
csi-gce-pd-default pd.csi.storage.gke.io Delete WaitForFirstConsumer false 4h19m
```

#### Prior to Kubernetes 1.25

First we need to create a storage class which can be used by Kubernetes.
To start with, we will create one for the 'General Purpose SSD' type of EBS
storage:

For the standard disks:

```bash
Expand Down Expand Up @@ -134,6 +188,8 @@ gcp-ssd kubernetes.io/gce-pd 9s
gcp-standard kubernetes.io/gce-pd 45s
```

#### Creating a PVC

To actually create storage using this new class, you can make a Persistent Volume Claim:

```bash
Expand Down Expand Up @@ -281,15 +337,19 @@ curl 34.76.144.215:8080
Hello Kubernetes!
```

### Upgrading the integrator-charm
### Upgrading the charms

The gcp-integrator is not specifically tied to the version of **Charmed Kubernetes** installed and may
generally be upgraded at any time with the following command:
The charm `gcp-integrator` and `gcp-k8s-storage`
can be refreshed within the current charm channel without concern and
can be upgraded at any time with the following command,

```bash
juju refresh gcp-integrator
juju refresh gcp-k8s-storage
```

It isn't recommended to switch charm channels unless a full charm upgrade is planned.

### Troubleshooting

If you have any specific problems with the gcp-integrator, you can report bugs on
Expand All @@ -313,10 +373,11 @@ juju debug-log --replay --include gcp-integrator/0
[owner]: https://console.cloud.google.com/iam-admin/iam
[iam-roles]: https://cloud.google.com/compute/docs/access/iam
[asset-gcp-overlay]: https://raw.githubusercontent.com/charmed-kubernetes/bundle/main/overlays/gcp-overlay.yaml
[asset-gcp-storage-overlay]: https://raw.githubusercontent.com/charmed-kubernetes/bundle/main/overlays/gcp-storage-overlay.yaml
[operations]: https://console.cloud.google.com/compute/operations
[storage]: /kubernetes/docs/storage
[bugs]: https://bugs.launchpad.net/charmed-kubernetes
[gcp-integrator-readme]: https://charmhub.io/containers-gcp-integrator/
[gcp-integrator-readme]: https://charmhub.io/gcp-integrator/
[target-pool]: https://cloud.google.com/load-balancing/docs/target-pools
[install]: /kubernetes/docs/install-manual

Expand Down
Loading