Skip to content

Commit

Permalink
updated value file section
Browse files Browse the repository at this point in the history
  • Loading branch information
acarranoqovery committed Jan 30, 2024
1 parent 91618f1 commit ad41350
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 36 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ Have a look at the [Requirements][docs.getting-started.install-qovery.kubernetes

## Install your cluster

Qovery needs a Kubernetes cluster running on your AWS account.
If you don't have already an EKS cluster, create one on your AWS account and assign a minimum set of worker nodes to run Qovery (See the [requirements section][docs.getting-started.install-qovery.kubernetes.requirements]) and deploy your own applications.

If you already have an EKS cluster, make sure that:
For your cluster, make sure that:
- you have the Kubeconfig of the cluster
- (only if you want to use databases of type `container` with Qovery) the EKS worker nodes have a role assigned with the permission `AmazonEBSCSIDriverPolicy`

Expand All @@ -55,6 +55,8 @@ This step will not be necessary in the upcoming version of our self-managed offe

<li>

Create IAM user for Qovery

Create a IAM user on your AWS account, add the following in-line permissions to the user:

```json
Expand Down Expand Up @@ -95,6 +97,8 @@ Create a IAM user on your AWS account, add the following in-line permissions to

<li>

Create access keys

To create an `access key id` and `secret access key`, go to the Security Credentials tab of the `Qovery` user and press `Create access key`

<img src="/img/aws/aws-create-credentials-1.png" />
Expand All @@ -108,6 +112,8 @@ You can now save the `access key id` and `secret access key`

<li>

Allow access to the cluster

Once the user is created, make sure it has the proper access permissions on the EKS cluster (`system:masters`). Example with `eksctl`

```shell
Expand All @@ -129,31 +135,33 @@ eksctl create iamidentitymapping --arn <iam_user_arn> --region <cluster_region>

Create a cluster on the Qovery console

Login to the [Qovery console][urls.qovery_console], and create a "Self-Managed" cluster:
Login to the [Qovery console][urls.qovery_console], and create a "Self-Managed" cluster.

Set the name of the cluster (1), the installation type (2) and add as `Credentials` (3) the AWS key that you have created in the previous step.

<p align="center">
<img src="/img/install-qovery/self-managed/general.png" alt="Create Self-Managed cluster" />
</p>

Set the name of the cluster, the installation type and add as `Credentials` the AWS key that you have created in the previous step.
Add your cluster kubeconfig file, and click on "Continue".

<p align="center">
<img src="/img/install-qovery/self-managed/kubeconfig.png" alt="Add your Kubeconfig" />
</p>

Add your cluster kubeconfig file, and click on "Continue".

<Alert type="warning">

The credentials and the kubeconfig are temporary requirements that will disappear in the next versions. See the [Requirements][docs.getting-started.install-qovery.kubernetes.requirements] section for more information.

</Alert>

Verify your setup and create the cluster. At the end of this step, the cluster is created on the Qovery platform but not yet running on your AWS account.

<p align="center">
<img src="/img/install-qovery/self-managed/create.png" alt="Create the cluster" />
</p>

You'll finally be able to download a file containing the Qovery configuration for your cluster. The content of this file will be used later.
After creation, you'll finally be able to download a file containing the Qovery configuration for your cluster. The content of this file will be used later.

<p align="center">
<img src="/img/install-qovery/self-managed/qovery_override.png" alt="Override Helm chart config" />
Expand All @@ -176,25 +184,26 @@ qovery:
architectures: &architectures "AMD64
```
Note: you can access again this installation section using the `3 dots` button next to the cluster name.

</li>

<li>

Now we have to build a values.yaml to be used during the installation of Qovery on your cluster via Helm. You will find in the [helm chart git repository](https://github.com/Qovery/qovery-chart) a non exhaustive list of `values` example files. Depending on your need, download the one you want and update the configuration inside it.

Provided AWS examples are:
* `values-demo-aws.yaml`: this a pre-configured version to quickly setup Qovery on a demo cluster (**do not use this configuration in production**)
* `values-aws.yaml`: this is a complete version where you can customize the entire Qovery installation. Adapt it based on your needs.
Prepare the values.yaml file

Once you have downloaded the base values you want to use, replace the `qovery config` part with the configuration provided by the Qovery console (see previous step).
Now we have to build a values.yaml file to be used during the installation of the Qovery Helm charts on your cluster.

<Alert type="info">
You will find in the [helm chart git repository](https://github.com/Qovery/qovery-chart/tree/main/charts/qovery) a non exhaustive list of `values` example files that you can use to build your own configuration. The full list of parameters that can be configured within a values file can be found in the [Configuration page][docs.getting-started.install-qovery.kubernetes.byok-config].

Make sure that all fields having value `set-by-customer` are filled.

</Alert>
In the repository we provide two examples for AWS:
* `values-demo-aws.yaml`: this a pre-configured version to quickly setup Qovery on a demo cluster (**do not use this configuration in production**)
* `values-aws.yaml`: in this version you have to customize the entire Qovery installation. Adapt it based on your needs.

Learn more about the configuration in the [Configuration page][docs.getting-started.install-qovery.kubernetes.byok-config].
Once you have downloaded the example values file that you want to use:
- replace the `qovery` configuration part with the configuration retrieved from the Qovery console (see previous step)
- update the configuration based on your needs. You can find all the possible parameters and configurations within the [Configuration page][docs.getting-started.install-qovery.kubernetes.byok-config].
- make sure that every parameter has a value, there's a placeholder `set-by-customer` when your input is required.

</li>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ Have a look at the [Requirements][docs.getting-started.install-qovery.kubernetes

## Install your cluster

Qovery needs a Kubernetes cluster running on your AWS account.
If you don't have already an EKS cluster, create one on your AWS account and assign a minimum set of worker nodes to run Qovery (See the [requirements section][docs.getting-started.install-qovery.kubernetes.requirements]) and deploy your own applications.

If you already have an EKS cluster, make sure that:
For your cluster, make sure that:
- you have the Kubeconfig of the cluster
- (only if you want to use databases of type `container` with Qovery) the EKS worker nodes have a role assigned with the permission `AmazonEBSCSIDriverPolicy`

Expand All @@ -46,6 +46,8 @@ This step will not be necessary in the upcoming version of our self-managed offe

<li>

Create IAM user for Qovery

Create a IAM user on your AWS account, add the following in-line permissions to the user:

```json
Expand Down Expand Up @@ -86,6 +88,8 @@ Create a IAM user on your AWS account, add the following in-line permissions to

<li>

Create access keys

To create an `access key id` and `secret access key`, go to the Security Credentials tab of the `Qovery` user and press `Create access key`

<img src="/img/aws/aws-create-credentials-1.png" />
Expand All @@ -99,6 +103,8 @@ You can now save the `access key id` and `secret access key`

<li>

Allow access to the cluster

Once the user is created, make sure it has the proper access permissions on the EKS cluster (`system:masters`). Example with `eksctl`

```shell
Expand All @@ -120,31 +126,33 @@ eksctl create iamidentitymapping --arn <iam_user_arn> --region <cluster_region>

Create a cluster on the Qovery console

Login to the [Qovery console][urls.qovery_console], and create a "Self-Managed" cluster:
Login to the [Qovery console][urls.qovery_console], and create a "Self-Managed" cluster.

Set the name of the cluster (1), the installation type (2) and add as `Credentials` (3) the AWS key that you have created in the previous step.

<p align="center">
<img src="/img/install-qovery/self-managed/general.png" alt="Create Self-Managed cluster" />
</p>

Set the name of the cluster, the installation type and add as `Credentials` the AWS key that you have created in the previous step.
Add your cluster kubeconfig file, and click on "Continue".

<p align="center">
<img src="/img/install-qovery/self-managed/kubeconfig.png" alt="Add your Kubeconfig" />
</p>

Add your cluster kubeconfig file, and click on "Continue".

<Alert type="warning">

The credentials and the kubeconfig are temporary requirements that will disappear in the next versions. See the [Requirements][docs.getting-started.install-qovery.kubernetes.requirements] section for more information.

</Alert>

Verify your setup and create the cluster. At the end of this step, the cluster is created on the Qovery platform but not yet running on your AWS account.

<p align="center">
<img src="/img/install-qovery/self-managed/create.png" alt="Create the cluster" />
</p>

You'll finally be able to download a file containing the Qovery configuration for your cluster. The content of this file will be used later.
After creation, you'll finally be able to download a file containing the Qovery configuration for your cluster. The content of this file will be used later.

<p align="center">
<img src="/img/install-qovery/self-managed/qovery_override.png" alt="Override Helm chart config" />
Expand All @@ -167,25 +175,26 @@ qovery:
architectures: &architectures "AMD64
```

Note: you can access again this installation section using the `3 dots` button next to the cluster name.

</li>

<li>

Now we have to build a values.yaml to be used during the installation of Qovery on your cluster via Helm. You will find in the [helm chart git repository](https://github.com/Qovery/qovery-chart) a non exhaustive list of `values` example files. Depending on your need, download the one you want and update the configuration inside it.

Provided AWS examples are:
* `values-demo-aws.yaml`: this a pre-configured version to quickly setup Qovery on a demo cluster (**do not use this configuration in production**)
* `values-aws.yaml`: this is a complete version where you can customize the entire Qovery installation. Adapt it based on your needs.
Prepare the values.yaml file

Once you have downloaded the base values you want to use, replace the `qovery config` part with the configuration provided by the Qovery console (see previous step).
Now we have to build a values.yaml file to be used during the installation of the Qovery Helm charts on your cluster.

<Alert type="info">
You will find in the [helm chart git repository](https://github.com/Qovery/qovery-chart/tree/main/charts/qovery) a non exhaustive list of `values` example files that you can use to build your own configuration. The full list of parameters that can be configured within a values file can be found in the [Configuration page][docs.getting-started.install-qovery.kubernetes.byok-config].

Make sure that all fields having value `set-by-customer` are filled.

</Alert>
In the repository we provide two examples for AWS:
* `values-demo-aws.yaml`: this a pre-configured version to quickly setup Qovery on a demo cluster (**do not use this configuration in production**)
* `values-aws.yaml`: in this version you have to customize the entire Qovery installation. Adapt it based on your needs.

Learn more about the configuration in the [Configuration page][docs.getting-started.install-qovery.kubernetes.byok-config].
Once you have downloaded the example values file that you want to use:
- replace the `qovery` configuration part with the configuration retrieved from the Qovery console (see previous step)
- update the configuration based on your needs. You can find all the possible parameters and configurations within the [Configuration page][docs.getting-started.install-qovery.kubernetes.byok-config].
- make sure that every parameter has a value, there's a placeholder `set-by-customer` when your input is required.

</li>

Expand Down

0 comments on commit ad41350

Please sign in to comment.