From c1ffde6473e32d8a5ae610e28b9a528fdefabb8a Mon Sep 17 00:00:00 2001 From: Sarah Gibson <44771837+sgibson91@users.noreply.github.com> Date: Mon, 25 Mar 2024 15:56:06 +0000 Subject: [PATCH 1/3] Minor doc fixes about running eksctl commands --- docs/hub-deployment-guide/new-cluster/aws.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/hub-deployment-guide/new-cluster/aws.md b/docs/hub-deployment-guide/new-cluster/aws.md index 6c985d698f..6a81c8be1a 100644 --- a/docs/hub-deployment-guide/new-cluster/aws.md +++ b/docs/hub-deployment-guide/new-cluster/aws.md @@ -105,6 +105,10 @@ for all the possible options. You'd want to make sure to change at least the fol Once you have a `.jsonnet` file, you can render it into a config file that eksctl can read. +```{tip} +Make sure to run this command inside the `eksctl` directory. +``` + ```bash jsonnet $CLUSTER_NAME.jsonnet > $CLUSTER_NAME.eksctl.yaml ``` @@ -119,12 +123,12 @@ against the `*.jsonnet` file and regenerate the YAML file when needed by a Now you're ready to create the cluster! -```bash -eksctl create cluster --config-file=$CLUSTER_NAME.eksctl.yaml +```{tip} +Make sure to run this command **inside** the `eksctl` directory, otherwise it cannot discover the `ssh-keys` subfolder. ``` -```{tip} -Make sure the run this command **inside** the `eksctl` directory, otherwise it cannot discover the `ssh-keys` subfolder. +```bash +eksctl create cluster --config-file=$CLUSTER_NAME.eksctl.yaml ``` This might take a few minutes. From de492003ebbdda0d9cf18f432ab4ea7986040a04 Mon Sep 17 00:00:00 2001 From: Sarah Gibson Date: Mon, 25 Mar 2024 17:07:35 +0000 Subject: [PATCH 2/3] Remove the about setting up support for AWS from new cluster guide This note is already given in the support setup guide, which is a more appropriate place for it --- docs/hub-deployment-guide/new-cluster/aws.md | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/docs/hub-deployment-guide/new-cluster/aws.md b/docs/hub-deployment-guide/new-cluster/aws.md index 6a81c8be1a..030ff8f7ec 100644 --- a/docs/hub-deployment-guide/new-cluster/aws.md +++ b/docs/hub-deployment-guide/new-cluster/aws.md @@ -337,19 +337,3 @@ automatically deployed by our CI/CD system. Add an entry for the new cluster here. [`upgrade-support-and-staging`]: https://github.com/2i2c-org/infrastructure/blob/18f5a4f8f39ed98c2f5c99091ae9f19a1075c988/.github/workflows/deploy-hubs.yaml#L128-L166 - -## A note on the support chart for AWS clusters - -````{warning} -When you deploy the support chart on an AWS cluster, you **must** enable the -`cluster-autoscaler` sub-chart, otherwise the node groups will not automatically -scale. Include the following in your `support.values.yaml` file: - -```yaml -cluster-autoscaler: - enabled: true - autoDiscovery: - clusterName: - awsRegion: -``` -```` From ef057dfdb0f2eb5d9f7f2bddcabe5ba285eb907e Mon Sep 17 00:00:00 2001 From: Sarah Gibson Date: Mon, 25 Mar 2024 17:14:32 +0000 Subject: [PATCH 3/3] Add a callout to point out that some files may have already been created if the `deployer generate dedicated-cluster` command was used --- .../deploy-support/configure-support.md | 6 ++++++ .../deploy-support/register-central-grafana.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/docs/hub-deployment-guide/deploy-support/configure-support.md b/docs/hub-deployment-guide/deploy-support/configure-support.md index c99aba4dcd..182d17f622 100644 --- a/docs/hub-deployment-guide/deploy-support/configure-support.md +++ b/docs/hub-deployment-guide/deploy-support/configure-support.md @@ -6,6 +6,12 @@ These tools are [`ingress-nginx`](https://kubernetes.github.io/ingress-nginx/), This section will walk you through how to deploy the support chart on a cluster. +```{attention} +If you ran `deployer generate dedicated-cluster ...` during the [new cluster setup](new-cluster), +then a lot of these files will have already been created for you and you do not +need to recreate them, only update them if required. +``` + ## Create a `support.values.yaml` file in your chosen cluster folder In the `infrastructure` repo, the full filepath should be: `config/clusters//support.values.yaml`. diff --git a/docs/hub-deployment-guide/deploy-support/register-central-grafana.md b/docs/hub-deployment-guide/deploy-support/register-central-grafana.md index 48789cab23..b9b253a820 100644 --- a/docs/hub-deployment-guide/deploy-support/register-central-grafana.md +++ b/docs/hub-deployment-guide/deploy-support/register-central-grafana.md @@ -2,6 +2,12 @@ Once you have [deployed the support chart](deploy-support-chart), you must also register this cluster as a datasource for the [central Grafana dashboard](grafana-dashboards:central). This will allow you to visualize cluster statistics not only from the cluster-specific Grafana deployment but also from the central dashboard, that aggregates data from all the clusters. +```{attention} +If you ran `deployer generate dedicated-cluster ...` during the [new cluster setup](new-cluster), +then a lot of these files will have already been created for you and you do not +need to recreate them, only update them if required. +``` + ## Create a `support.secret.values.yaml` file Only 2i2c staff and our centralized grafana should be able to access the prometheus data on a cluster from outside the cluster.