From e59fb223876f808d199ff65ebd33eb1c78aa96a9 Mon Sep 17 00:00:00 2001 From: Marcelo Villa Date: Fri, 9 Aug 2024 08:15:35 -0500 Subject: [PATCH 1/6] Move TOC to the top and get rid of gcloud requirements --- docs/docs/how-tos/nebari-gcp.md | 22 ++++++++-------------- 1 file changed, 8 insertions(+), 14 deletions(-) diff --git a/docs/docs/how-tos/nebari-gcp.md b/docs/docs/how-tos/nebari-gcp.md index 55ace439c..02c31f0ab 100644 --- a/docs/docs/how-tos/nebari-gcp.md +++ b/docs/docs/how-tos/nebari-gcp.md @@ -4,20 +4,20 @@ title: Deploy Nebari on GCP description: A basic overview of how to deploy Nebari on GCP. --- -## Introduction - -This guide is to help first-time users set up a Google Cloud Platform account specifically for the purpose of using and deploying Nebari at a production scale. In this guide we -will walk you through the following steps: - - [Introduction](#introduction) - [Sign up for Google Cloud Platform](#sign-up-for-google-cloud-platform) -- [Set up the `gcloud` CLI](#set-up-the-gcloud-cli) - [Authentication](#authentication) +- [Required GCP APIs](#required-gcp-apis) - [Initializing Nebari](#initializing-nebari) - [Deploying Nebari](#deploying-nebari) - [Destroying Nebari](#destroying-nebari) -For those already familiar with Google Cloud Platform and `gcloud`, feel free to skip this first step and jump straight to the [Nebari authentication](#authentication) section of +## Introduction + +This guide is to help first-time users set up a Google Cloud Platform account specifically for the purpose of using and deploying Nebari at a production scale. In this guide we +will walk you through the following steps: + +For those already familiar with Google Cloud Platform, feel free to skip this first step and jump straight to the [Nebari authentication](#authentication) section of this guide. ## Sign up for Google Cloud Platform @@ -46,12 +46,6 @@ A Nebari deployment on GCP will **NOT** fall into `free tier` usage. Therefore, administrator for more information. If you provision resources outside the free tier, you may be charged. We're not responsible for any charges you may incur if this happens. ::: -## Set up the `gcloud` CLI - -As Nebari executes some preliminary steps to check Kubernetes compatibility within the GCP infrastructure, it needs to use the -[`gcloud` command line interface (CLI)](https://cloud.google.com/sdk/gcloud) to interact with the Google Cloud Platform. You will have to -[install the `gcloud` CLI on your system](https://cloud.google.com/sdk/docs/install) before you can use Nebari. - The remaining steps will assume that you are logged in to a GCP account that has admin privileges for the newly created project. ## Authentication @@ -114,7 +108,7 @@ startup file (for example, for example in the `~/.bashrc` or `~/.profile` for th :::note The steps in the following sections assume you have (i) completed the [Install Nebari][nebari-install] section, (ii) confirmed that Nebari is successfully -installed in your environment, (iii) opted for **GCP** as your cloud provider which includes installing and initializing `gcloud`, and (iv) already configured the Nebari +installed in your environment, (iii) opted for **GCP** as your cloud provider, and (iv) already configured the Nebari environment variables. If you had any issues during the installation, please visit the "Get started" section of our [troubleshooting page][nebari-troubleshooting] for further guidance. ::: From d4c08b4440d289043f801984f60ccccff438c506 Mon Sep 17 00:00:00 2001 From: Marcelo Villa Date: Wed, 30 Oct 2024 09:23:52 +0100 Subject: [PATCH 2/6] Move TOC below introduction paragraph for consistency --- docs/docs/how-tos/nebari-gcp.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/docs/how-tos/nebari-gcp.md b/docs/docs/how-tos/nebari-gcp.md index deb07abab..7cd422f1f 100644 --- a/docs/docs/how-tos/nebari-gcp.md +++ b/docs/docs/how-tos/nebari-gcp.md @@ -4,6 +4,11 @@ title: Deploy Nebari on GCP description: A basic overview of how to deploy Nebari on GCP. --- +## Introduction + +This guide is to help first-time users set up a Google Cloud Platform account specifically for the purpose of using and deploying Nebari at a production scale. In this guide we +will walk you through the following steps: + - [Introduction](#introduction) - [Sign up for Google Cloud Platform](#sign-up-for-google-cloud-platform) - [Authentication](#authentication) @@ -12,11 +17,6 @@ description: A basic overview of how to deploy Nebari on GCP. - [Deploying Nebari](#deploying-nebari) - [Destroying Nebari](#destroying-nebari) -## Introduction - -This guide is to help first-time users set up a Google Cloud Platform account specifically for the purpose of using and deploying Nebari at a production scale. In this guide we -will walk you through the following steps: - For those already familiar with Google Cloud Platform, feel free to skip this first step and jump straight to the [Nebari authentication](#authentication) section of this guide. From c5f2dbe90809bd730245f5e660eefdaae8f97ab4 Mon Sep 17 00:00:00 2001 From: Marcelo Villa Date: Wed, 30 Oct 2024 09:28:42 +0100 Subject: [PATCH 3/6] Add note on installing gcloud for older versions --- docs/docs/how-tos/nebari-gcp.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/docs/how-tos/nebari-gcp.md b/docs/docs/how-tos/nebari-gcp.md index 7cd422f1f..89ce05e7c 100644 --- a/docs/docs/how-tos/nebari-gcp.md +++ b/docs/docs/how-tos/nebari-gcp.md @@ -20,6 +20,10 @@ will walk you through the following steps: For those already familiar with Google Cloud Platform, feel free to skip this first step and jump straight to the [Nebari authentication](#authentication) section of this guide. +:::note +Before version 2024.9.1, Nebari relied on users having `gcloud`, Google Cloud's CLI, installed locally on the machine they were deploying Nebari from. If you want to install an older version, make sure to [install it](https://cloud.google.com/sdk/docs/install). +::: + ## Sign up for Google Cloud Platform This documentation assumes that you are already familiar with Google Cloud Platform accounts, and that you have prior knowledge regarding GCP billing and cost usage for Kubernetes related From 95509be96f1593c4ba70f40430c781c882c43ebc Mon Sep 17 00:00:00 2001 From: Marcelo Villa Date: Wed, 30 Oct 2024 09:38:04 +0100 Subject: [PATCH 4/6] Make note important --- docs/docs/how-tos/nebari-gcp.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/how-tos/nebari-gcp.md b/docs/docs/how-tos/nebari-gcp.md index 89ce05e7c..a654b7f47 100644 --- a/docs/docs/how-tos/nebari-gcp.md +++ b/docs/docs/how-tos/nebari-gcp.md @@ -20,7 +20,7 @@ will walk you through the following steps: For those already familiar with Google Cloud Platform, feel free to skip this first step and jump straight to the [Nebari authentication](#authentication) section of this guide. -:::note +:::note important Before version 2024.9.1, Nebari relied on users having `gcloud`, Google Cloud's CLI, installed locally on the machine they were deploying Nebari from. If you want to install an older version, make sure to [install it](https://cloud.google.com/sdk/docs/install). ::: From 8252c28ee1997608edbe78933de6daf7379b8504 Mon Sep 17 00:00:00 2001 From: Marcelo Villa Date: Wed, 30 Oct 2024 09:43:13 +0100 Subject: [PATCH 5/6] Make note a warning instead --- docs/docs/how-tos/nebari-gcp.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/how-tos/nebari-gcp.md b/docs/docs/how-tos/nebari-gcp.md index a654b7f47..7c689c658 100644 --- a/docs/docs/how-tos/nebari-gcp.md +++ b/docs/docs/how-tos/nebari-gcp.md @@ -20,7 +20,7 @@ will walk you through the following steps: For those already familiar with Google Cloud Platform, feel free to skip this first step and jump straight to the [Nebari authentication](#authentication) section of this guide. -:::note important +:::warning important Before version 2024.9.1, Nebari relied on users having `gcloud`, Google Cloud's CLI, installed locally on the machine they were deploying Nebari from. If you want to install an older version, make sure to [install it](https://cloud.google.com/sdk/docs/install). ::: From 4e644bec1f66d1b739c23f88b67ae1f6162492bc Mon Sep 17 00:00:00 2001 From: Marcelo Villa Date: Wed, 13 Nov 2024 22:55:27 +0100 Subject: [PATCH 6/6] Run linter --- docs/docs/how-tos/nebari-gcp.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/docs/how-tos/nebari-gcp.md b/docs/docs/how-tos/nebari-gcp.md index 90e3426fc..59583e515 100644 --- a/docs/docs/how-tos/nebari-gcp.md +++ b/docs/docs/how-tos/nebari-gcp.md @@ -64,6 +64,7 @@ management. If it's your first time creating a service account, please follow [these detailed instructions](https://cloud.google.com/iam/docs/creating-managing-service-accounts) to create a Google Service Account with the following roles attached: + - [`roles/editor`](https://cloud.google.com/iam/docs/understanding-roles#editor) - [`roles/resourcemanager.projectIamAdmin`](https://cloud.google.com/iam/docs/understanding-roles#resourcemanager.projectIamAdmin) - [`roles/container.admin`](https://cloud.google.com/iam/docs/understanding-roles#container.admin)