Commit d96d205a authored by Marcia Ramos's avatar Marcia Ramos

Merge branch 'docs/autodevops-k8s' into 'master'

Document end to end flow for Kubernetes and Auto DevOps

Closes #44455

See merge request gitlab-org/gitlab-ce!19699
parents 8db69d19 1781ec14
# Auto DevOps # Auto DevOps
> [Introduced][ce-37115] in GitLab 10.0. > [Introduced][ce-37115] in GitLab 10.0. Generally available on GitLab 11.0.
Auto DevOps automatically detects, builds, tests, deploys, and monitors your Auto DevOps automatically detects, builds, tests, deploys, and monitors your
applications. applications.
...@@ -13,6 +13,12 @@ without needing to configure anything. Just push your code and GitLab takes ...@@ -13,6 +13,12 @@ without needing to configure anything. Just push your code and GitLab takes
care of everything else. This makes it easier to start new projects and brings care of everything else. This makes it easier to start new projects and brings
consistency to how applications are set up throughout a company. consistency to how applications are set up throughout a company.
## Quick start
If you are using GitLab.com, see the [quick start guide](quick_start_guide.md)
for using Auto DevOps with GitLab.com and a Kubernetes cluster on Google Kubernetes
Engine.
## Comparison to application platforms and PaaS ## Comparison to application platforms and PaaS
Auto DevOps provides functionality described by others as an application Auto DevOps provides functionality described by others as an application
...@@ -34,7 +40,7 @@ in a couple of ways: ...@@ -34,7 +40,7 @@ in a couple of ways:
## Features ## Features
Comprised of a set of stages, Auto DevOps brings these best practices to your Comprised of a set of stages, Auto DevOps brings these best practices to your
project in an easy and automatic way: project in a simple and automatic way:
1. [Auto Build](#auto-build) 1. [Auto Build](#auto-build)
1. [Auto Test](#auto-test) 1. [Auto Test](#auto-test)
...@@ -135,10 +141,9 @@ and `1.2.3.4` is the IP address of your load balancer; generally NGINX ...@@ -135,10 +141,9 @@ and `1.2.3.4` is the IP address of your load balancer; generally NGINX
([see requirements](#requirements)). How to set up the DNS record is beyond ([see requirements](#requirements)). How to set up the DNS record is beyond
the scope of this document; you should check with your DNS provider. the scope of this document; you should check with your DNS provider.
Alternatively you can use free public services like [nip.io](http://nip.io) or Alternatively you can use free public services like [nip.io](http://nip.io)
[nip.io](http://nip.io) which provide automatic wildcard DNS without any which provide automatic wildcard DNS without any configuration. Just set the
configuration. Just set the Auto DevOps base domain to `1.2.3.4.nip.io` or Auto DevOps base domain to `1.2.3.4.nip.io`.
`1.2.3.4.nip.io`.
Once set up, all requests will hit the load balancer, which in turn will route Once set up, all requests will hit the load balancer, which in turn will route
them to the Kubernetes pods that run your application(s). them to the Kubernetes pods that run your application(s).
...@@ -198,12 +203,6 @@ and verifying that your app is deployed as a review app in the Kubernetes ...@@ -198,12 +203,6 @@ and verifying that your app is deployed as a review app in the Kubernetes
cluster with the `review/*` environment scope. Similarly, you can check the cluster with the `review/*` environment scope. Similarly, you can check the
other environments. other environments.
## Quick start
If you are using GitLab.com, see our [quick start guide](quick_start_guide.md)
for using Auto DevOps with GitLab.com and an external Kubernetes cluster on
Google Cloud.
## Enabling Auto DevOps ## Enabling Auto DevOps
If you haven't done already, read the [requirements](#requirements) to make If you haven't done already, read the [requirements](#requirements) to make
...@@ -288,7 +287,7 @@ NOTE: **Note:** ...@@ -288,7 +287,7 @@ NOTE: **Note:**
Auto Test uses tests you already have in your application. If there are no Auto Test uses tests you already have in your application. If there are no
tests, it's up to you to add them. tests, it's up to you to add them.
### Auto Code Quality ### Auto Code Quality **[STARTER]**
Auto Code Quality uses the Auto Code Quality uses the
[Code Quality image](https://gitlab.com/gitlab-org/security-products/codequality) to run [Code Quality image](https://gitlab.com/gitlab-org/security-products/codequality) to run
...@@ -323,7 +322,7 @@ to run analysis on the project dependencies and checks for potential security is ...@@ -323,7 +322,7 @@ to run analysis on the project dependencies and checks for potential security is
report is created, it's uploaded as an artifact which you can later download and report is created, it's uploaded as an artifact which you can later download and
check out. check out.
In GitLab Ultimate, any security warnings are also Any security warnings are also
[shown in the merge request widget](https://docs.gitlab.com/ee//user/project/merge_requests/dependency_scanning.html). [shown in the merge request widget](https://docs.gitlab.com/ee//user/project/merge_requests/dependency_scanning.html).
### Auto License Management **[ULTIMATE]** ### Auto License Management **[ULTIMATE]**
...@@ -331,12 +330,12 @@ In GitLab Ultimate, any security warnings are also ...@@ -331,12 +330,12 @@ In GitLab Ultimate, any security warnings are also
> Introduced in [GitLab Ultimate][ee] 11.0. > Introduced in [GitLab Ultimate][ee] 11.0.
License Management uses the License Management uses the
[License Management Docker image](https://gitlab.com/gitlab-org/security-products/license_management) [License Management Docker image](https://gitlab.com/gitlab-org/security-products/license-management)
to search the project dependencies for their license. Once the to search the project dependencies for their license. Once the
report is created, it's uploaded as an artifact which you can later download and report is created, it's uploaded as an artifact which you can later download and
check out. check out.
In GitLab Ultimate, any licenses are also Any licenses are also
[shown in the merge request widget](https://docs.gitlab.com/ee//user/project/merge_requests/license_management.html). [shown in the merge request widget](https://docs.gitlab.com/ee//user/project/merge_requests/license_management.html).
### Auto Container Scanning ### Auto Container Scanning
......
# Auto DevOps: quick start guide # Getting started with Auto DevOps
> [Introduced][ce-37115] in GitLab 10.0. This is a step-by-step guide that will help you use [Auto DevOps](index.md) to
deploy a project hosted on GitLab.com to Google Kubernetes Engine.
This is a step-by-step guide to deploying a project hosted on GitLab.com to We will use GitLab's native Kubernetes integration, so you will not need
Google Cloud, using Auto DevOps. to create a Kubernetes cluster manually using the Google Cloud Platform console.
We will create and deploy a simple application that we create from a GitLab template.
We made a minimal [Ruby These instructions will also work for a self-hosted GitLab instance; you'll just
application](https://gitlab.com/auto-devops-examples/minimal-ruby-app) to use need to ensure your own [Runners are configured](../../ci/runners/README.md) and
as an example for this guide. It contains two main files: [Google OAuth is enabled](../../integration/google.md).
* `server.rb` - our application. It will start an HTTP server on port 5000 and ## Configuring your Google account
render "Hello, world!"
* `Dockerfile` - to build our app into a container image. It will use a ruby
base image and run `server.rb`
## Fork sample project on GitLab.com Before creating and connecting your Kubernetes cluster to your GitLab project,
you need a Google Cloud Platform account. If you don't already have one,
sign up at https://console.cloud.google.com. You'll need to either sign in with an existing
Google account (for example, one that you use to access Gmail, Drive, etc.) or create a new one.
Let’s start by forking our sample application. Go to [the project 1. Follow the steps as outlined in the ["Before you begin" section of the Kubernetes Engine docs](https://cloud.google.com/kubernetes-engine/docs/quickstart#before-you-begin)
page](https://gitlab.com/auto-devops-examples/minimal-ruby-app) and press the in order for the required APIs and related services to be enabled.
**Fork** button. Soon you should have a project under your namespace with the 1. Make sure you have created a [billing account](https://cloud.google.com/billing/docs/how-to/manage-billing-account).
necessary files.
You can also start a new project from a TIP: **Tip:**
[GitLab project template](https://gitlab.com/gitlab-org/project-templates) if Every new Google Cloud Platform (GCP) account receives [$300 in credit](https://console.cloud.google.com/freetrial),
you want to use a different language. and in partnership with Google, GitLab is able to offer an additional $200 for new GCP accounts to get started with GitLab's
Google Kubernetes Engine Integration. All you have to do is [follow this link](https://goo.gl/AaJzRW) and apply for credit.
## Setup your own cluster on Google Kubernetes Engine ## Creating a new project from a template
If you do not already have a Google Cloud account, create one at We will use one of GitLab's project templates to get started. As the name suggests,
https://console.cloud.google.com. those projects provide a barebones application built on some well-known frameworks.
Visit the [**Kubernetes Engine**](https://console.cloud.google.com/kubernetes/list) 1. In GitLab, click the plus icon (**+**) at the top of the navigation bar and select
tab and create a new cluster. You can change the name and leave the rest of the **New project**.
default settings. Once you have your cluster running, you need to connect to the 1. Go to the **Create from template** tab where you can choose among a Ruby on
cluster by following the Google interface. Rails, Spring, or NodeJS Express project. For this example,
we'll use the Ruby on Rails template.
## Connect to Kubernetes cluster ![Select project template](img/guide_project_template.png)
You need to have the Google Cloud SDK installed. e.g. 1. Give your project a name, optionally a description, and make it public so that
On macOS, install [homebrew](https://brew.sh): you can take advantage of the features available in the
[GitLab Gold plan](https://about.gitlab.com/pricing/#gitlab-com).
1. Install Brew Caskroom: `brew install caskroom/cask/brew-cask` ![Create project](img/guide_create_project.png)
2. Install Google Cloud SDK: `brew cask install google-cloud-sdk`
3. Add `kubectl` with: `gcloud components install kubectl`
4. Log in: `gcloud auth login`
Now go back to the Google interface, find your cluster, follow the instructions 1. Click **Create project**.
under "Connect to the cluster" and open the Kubernetes Dashboard. It will look
something like:
```sh Now that the project is created, the next step is to create the Kubernetes cluster
gcloud container clusters get-credentials ruby-autodeploy \ --zone europe-west2-c --project api-project-XXXXXXX under which this application will be deployed.
```
Finally, run `kubectl proxy`. ## Creating a Kubernetes cluster from within GitLab
![connect to cluster](img/guide_connect_cluster.png) 1. On the project's landing page, click the button labeled **Add Kubernetes cluster**
(note that this option is also available when you navigate to **Operations > Kubernetes**).
## Copy credentials to GitLab.com project ![Project landing page](img/guide_project_landing_page.png)
Once you have the Kubernetes Dashboard interface running, you should visit 1. Choose **Create on Google Kubernetes Engine**.
**Secrets** under the "Config" section. There, you should find the settings we
need for GitLab integration: `ca.crt` and token.
![connect to cluster](img/guide_secret.png) ![Choose GKE](img/guide_choose_gke.png)
You need to copy-paste the `ca.crt` and token into your project on GitLab.com in 1. Sign in with Google.
the Kubernetes integration page under project
**Settings > Integrations > Project services > Kubernetes**. Don't actually copy
the namespace though. Each project should have a unique namespace, and by leaving
it blank, GitLab will create one for you.
![connect to cluster](img/guide_integration.png) ![Google sign in](img/guide_google_signin.png)
For the API URL, you should use the "Endpoint" IP from your cluster page on 1. Connect with your Google account and press **Allow** when asked (this will
Google Cloud Platform. be shown only the first time you connect GitLab with your Google account).
## Expose application to the world ![Google auth](img/guide_google_auth.png)
In order to be able to visit your application, you need to install an NGINX 1. The last step is to fill in the cluster details. Give it a name, leave the
ingress controller and point your domain name to its external IP address. Let's environment scope as is, and choose the GCP project under which the cluster
see how that's done. will be created. (Per the instructions when you
[configured your Google account](#configuring-your-google-account), a project
should have already been created for you.) Next, choose the
[region/zone](https://cloud.google.com/compute/docs/regions-zones/) under which the
cluster will be created, enter the number of nodes you want it to have, and
finally choose their [machine type](https://cloud.google.com/compute/docs/machine-types).
### Set up Ingress controller ![GitLab GKE cluster details](img/guide_gitlab_gke_details.png)
You’ll need to make sure you have an ingress controller. If you don’t have one, do: 1. Once ready, click **Create Kubernetes cluster**.
```sh After a couple of minutes, the cluster will be created. You can also see its
brew install kubernetes-helm status on your [GCP dashboard](https://console.cloud.google.com/kubernetes).
helm init
helm install --name ruby-app stable/nginx-ingress
```
This should create several services including `ruby-app-nginx-ingress-controller`. The next step is to install some applications on your cluster that are needed
You can list your services by running `kubectl get svc` to confirm that. to take full advantage of Auto DevOps.
### Point DNS at Cluster IP ## Installing Helm, Ingress, and Prometheus
Find out the external IP address of the `ruby-app-nginx-ingress-controller` by GitLab's Kubernetes integration comes with some
running: [pre-defined applications](../../user/project/clusters/index.md#installing-applications)
for you to install.
```sh ![Cluster applications](img/guide_cluster_apps.png)
kubectl get svc ruby-app-nginx-ingress-controller -o jsonpath='{.status.loadBalancer.ingress[0].ip}'
``` The first one to install is Helm Tiller, a package manager for Kubernetes, which
is needed in order to install the rest of the applications. Go ahead and click
its **Install** button.
Once it's installed, the other applications that rely on it will each have their **Install**
button enabled. For this guide, we need Ingress and Prometheus. Ingress provides
load balancing, SSL termination, and name-based virtual hosting, using NGINX behind
the scenes. Prometheus is an open-source monitoring and alerting system that we'll
use to supervise the deployed application. We will not install GitLab Runner as
we'll use the shared Runners that GitLab.com provides.
After the Ingress is installed, wait a few seconds and copy the IP address that
is displayed, which we'll use in the next step when enabling Auto DevOps.
## Enabling Auto DevOps
Now that the Kubernetes cluster is set up and ready, let's enable Auto DevOps.
1. First, navigate to **Settings > CI/CD > Auto DevOps**.
1. Select **Enable Auto DevOps**.
1. Add in your base **Domain** by using the one GitLab suggests. Note that
generally, you would associate the IP address with a domain name on your
registrar's settings. In this case, for the sake of the guide, we will use
an alternative DNS that will map any domain name of the scheme
`anything.ip_address.nip.io` to the corresponding `ip_address`. For example,
if the IP address of the Ingress is `1.2.3.4`, the domain name to fill in
would be `1.2.3.4.nip.io`.
1. Lastly, let's select the [continuous deployment strategy](index.md#deployment-strategy)
which will automatically deploy the application to production once the pipeline
successfully runs on the `master` branch.
1. Click **Save changes**.
![Auto DevOps settings](img/guide_enable_autodevops.png)
Once you complete all the above and save your changes, a new pipeline is
automatically created. To view the pipeline, go to **CI/CD > Pipelines**.
![First pipeline](img/guide_first_pipeline.png)
In the next section we'll break down the pipeline and explain what each job does.
## Deploying the application
By now you should see the pipeline running, but what is it running exactly?
To navigate inside the pipeline, click its status badge. (It's status should be "running").
The pipeline is split into 4 stages, each running a couple of jobs.
![Pipeline stages](img/guide_pipeline_stages.png)
In the **build** stage, the application is built into a Docker image and then
uploaded to your project's [Container Registry](../../user/project/container_registry.md) ([Auto Build](index.md#auto-build)).
In the **test** stage, GitLab runs various checks on the application:
- The `test` job runs unit and integration tests by detecting the language and
framework ([Auto Test](index.md#auto-test))
- The `code_quality` job checks the code quality and is allowed to fail
([Auto Code Quality](index.md#auto-code-quality)) **[STARTER]**
- The `container_scanning` job checks the Docker container if it has any
vulnerabilities and is allowed to fail ([Auto Container Scanning](index.md#auto-container-scanning))
- The `dependency_scanning` job checks if the application has any dependencies
susceptible to vulnerabilities and is allowed to fail ([Auto Dependency Scanning](index.md#auto-dependency-scanning)) **[ULTIMATE]**
- The `sast` job runs static analysis on the current code to check for potential
security issues and is allowed to fail([Auto SAST](index.md#auto-sast)) **[ULTIMATE]**
- The `license_management` job searches the application's dependencies to determine each of their
licenses and is allowed to fail ([Auto License Management](index.md#auto-license-management)) **[ULTIMATE]**
NOTE: **Note:** NOTE: **Note:**
If your ingress controller has been installed in a different way, you can find As you might have noticed, all jobs except `test` are allowed to fail in the
how to get the external IP address in the test stage.
[Cluster documentation](../../user/project/clusters/index.md#getting-the-external-ip-address).
The **production** stage is run after the tests and checks finish, and it automatically
deploys the application in Kubernetes ([Auto Deploy](index.md#auto-deploy)).
Lastly, in the **performance** stage, some performance tests will run
on the deployed application
([Auto Browser Performance Testing](index.md#auto-browser-performance-testing)). **[PREMIUM]**
---
Use this IP address to configure your DNS. This part heavily depends on your The URL for the deployed application can be found under the **Environments**
preferences and domain provider. But in case you are not sure, just create an page where you can also monitor your application. Let's explore that.
A record with a wildcard host like `*.<your-domain>`.
### Monitoring
Now that the application is successfully deployed, let's navigate to its
website. First, go to **Operations > Environments**.
![Environments](img/guide_environments.png)
In **Environments** you can see some details about the deployed
applications. In the rightmost column for the production environment, you can make use of the three icons:
- The first icon will open the URL of the application that is deployed in
production. It's a very simple page, but the important part is that it works!
- The next icon with the small graph will take you to the metrics page where
Prometheus collects data about the Kubernetes cluster and how the application
affects it (in terms of memory/CPU usage, latency, etc.).
![Environments metrics](img/guide_environments_metrics.png)
- The third icon is the [web terminal](../../ci/environments.md#web-terminals)
and it will open a terminal session right inside the container where the
application is running.
Right below, there is the
[Deploy Board](https://docs.gitlab.com/ee/user/project/deploy_boards.md).
The squares represent pods in your Kubernetes cluster that are associated with
the given environment. Hovering above each square you can see the state of a
deployment and clicking a square will take you to the pod's logs page.
TIP: **Tip:**
There is only one pod hosting the application at the moment, but you can add
more pods by defining the [`REPLICAS` variable](index.md#environment-variables)
under **Settings > CI/CD > Variables**.
### Working with branches
Following the [GitLab flow](../../workflow/gitlab_flow.md#working-with-feature-branches)
let's create a feature branch that will add some content to the application.
Under your repository, navigate to the following file: `app/views/welcome/index.html.erb`.
By now, it should only contain a paragraph: `<p>You're on Rails!</p>`, so let's
start adding content. Let's use GitLab's [Web IDE](../../user/project/web_ide/index.md) to make the change. Once
you're on the Web IDE, make the following change:
```html
<p>You're on Rails! Powered by GitLab Auto DevOps.</p>
```
Stage the file, add a commit message, and create a new branch and a merge request
by clicking **Commit**.
![Web IDE commit](img/guide_ide_commit.png)
Once you submit the merge request, you'll see the pipeline running. This will
run all the jobs as [described previously](#deploying-the-application), as well
a few more that run only on branches other than `master`.
![Merge request](img/guide_merge_request.png)
After a few minutes you'll notice that there was a failure in a test.
This means there's a test that was 'broken' by our change.
Navigating into the `test` job that failed, you can see what the broken test is:
```
Failure:
WelcomeControllerTest#test_should_get_index [/app/test/controllers/welcome_controller_test.rb:7]:
<You're on Rails!> expected but was
<You're on Rails! Powered by GitLab Auto DevOps.>..
Expected 0 to be >= 1.
bin/rails test test/controllers/welcome_controller_test.rb:4
```
Use `nslookup minimal-ruby-app-staging.<yourdomain>` to confirm that domain is Let's fix that:
assigned to the cluster IP.
## Set up Auto DevOps 1. Back to the merge request, click the **Web IDE** button.
1. Find the `test/controllers/welcome_controller_test.rb` file and open it.
1. Change line 7 to say `You're on Rails! Powered by GitLab Auto DevOps.`
1. Click **Commit**.
1. On your left, under "Unstaged changes", click the little checkmark icon
to stage the changes.
1. Write a commit message and click **Commit**.
In your GitLab.com project, go to **Settings > CI/CD** and find the Auto DevOps Now, if you go back to the merge request you should not only see the test passing,
section. Select "Enable Auto DevOps", add in your base domain, and save. but also the application deployed as a [review app](index.md#auto-review-apps). You
can visit it by following the URL in the merge request. The changes that we
previously made should be there.
Next, a pipeline needs to be triggered. Since the test project doesn't have a ![Review app](img/guide_merge_request_review_app.png)
`.gitlab-ci.yml`, you need to either push a change to the repository or
manually visit `https://gitlab.com/<username>/minimal-ruby-app/pipelines/new`,
where `<username>` is your username.
This will create a new pipeline with several jobs: `build`, `test`, `code_quality`, Once you merge the merge request, the pipeline will run on the `master` branch,
and `production`. The `build` job will create a Docker image with your new and the application will be eventually deployed straight to production.
change and push it to the Container Registry. The `test` job will test your
changes, whereas the `code_quality` job will run static analysis on your changes.
Finally, the `production` job will deploy your changes to a production application.
Once the deploy job succeeds you should be able to see your application by ## Conclusion
visiting the Kubernetes dashboard. Select the namespace of your project, which
will look like `minimal-ruby-app-23`, but with a unique ID for your project,
and your app will be listed as "production" under the Deployment tab.
Once its ready, just visit `http://minimal-ruby-app.example.com` to see the After implementing this project, you should now have a solid understanding of the basics of Auto DevOps.
famous "Hello, world!"! We started from building and testing to deploying and monitoring an application
all within GitLab. Despite its automatic nature, Audo DevOps can also be configured
and customized to fit your workflow. Here are some helpful resources for further reading:
[ce-37115]: https://gitlab.com/gitlab-org/gitlab-ce/issues/37115 1. [Auto DevOps](index.md)
1. [Multiple Kubernetes clusters](index.md#using-multiple-kubernetes-clusters) **[PREMIUM]**
1. [Incremental rollout to production](index.md#incremental-rollout-to-production) **[PREMIUM]**
1. [Disable jobs you don't need with environment variables](index.md#environment-variables)
1. [Use a static IP for your cluster](../../user/project/clusters/index.md#using-a-static-ip)
1. [Use your own buildpacks to build your application](index.md#custom-buildpacks)
1. [Prometheus monitoring](../../user/project/integrations/prometheus.md)
...@@ -7,9 +7,10 @@ cluster in a few steps. ...@@ -7,9 +7,10 @@ cluster in a few steps.
## Overview ## Overview
With a Kubernetes cluster associated to your project, you can use With one or more Kubernetes clusters associated to your project, you can use
[Review Apps](../../../ci/review_apps/index.md), deploy your applications, run [Review Apps](../../../ci/review_apps/index.md), deploy your applications, run
your pipelines, and much more, in an easy way. your pipelines, use it with [Auto DevOps](../../../topics/autodevops/index.md),
and much more, all from within GitLab.
There are two options when adding a new cluster to your project; either associate There are two options when adding a new cluster to your project; either associate
your account with Google Kubernetes Engine (GKE) so that you can [create new your account with Google Kubernetes Engine (GKE) so that you can [create new
...@@ -18,59 +19,65 @@ or provide the credentials to an [existing Kubernetes cluster](#adding-an-existi ...@@ -18,59 +19,65 @@ or provide the credentials to an [existing Kubernetes cluster](#adding-an-existi
## Adding and creating a new GKE cluster via GitLab ## Adding and creating a new GKE cluster via GitLab
TIP: **Tip:**
Every new Google Cloud Platform (GCP) account receives [$300 in credit upon sign up](https://console.cloud.google.com/freetrial),
and in partnership with Google, GitLab is able to offer an additional $200 for new GCP accounts to get started with GitLab's
Google Kubernetes Engine Integration. All you have to do is [follow this link](https://goo.gl/AaJzRW) and apply for credit.
NOTE: **Note:** NOTE: **Note:**
You need Maintainer [permissions] and above to access the Kubernetes page. The [Google authentication integration](../../../integration/google.md) must
be enabled in GitLab at the instance level. If that's not the case, ask your
Before proceeding, make sure the following requirements are met: GitLab administrator to enable it. On GitLab.com, this is enabled.
- The [Google authentication integration](../../../integration/google.md) must ### Requirements
be enabled in GitLab at the instance level. If that's not the case, ask your
GitLab administrator to enable it. Before creating your first cluster on Google Kubernetes Engine with GitLab's
- Your associated Google account must have the right privileges to manage integration, make sure the following requirements are met:
clusters on GKE. That would mean that a [billing
account](https://cloud.google.com/billing/docs/how-to/manage-billing-account) - A [billing account](https://cloud.google.com/billing/docs/how-to/manage-billing-account)
must be set up and that you have to have permissions to access it. is set up and you have permissions to access it.
- You must have Maintainer [permissions] in order to be able to access the - The Kubernetes Engine API is enabled. Follow the steps as outlined in the
**Kubernetes** page. ["Before you begin" section of the Kubernetes Engine docs](https://cloud.google.com/kubernetes-engine/docs/quickstart#before-you-begin).
- You must have [Cloud Billing API](https://cloud.google.com/billing/) enabled
- You must have [Resource Manager ### Creating the cluster
API](https://cloud.google.com/resource-manager/)
If all of the above requirements are met, you can proceed to create and add a If all of the above requirements are met, you can proceed to create and add a
new Kubernetes cluster that will be hosted on GKE to your project: new Kubernetes cluster to your project:
1. Navigate to your project's **Operations > Kubernetes** page. 1. Navigate to your project's **Operations > Kubernetes** page.
NOTE: **Note:**
You need Maintainer [permissions] and above to access the Kubernetes page.
1. Click on **Add Kubernetes cluster**. 1. Click on **Add Kubernetes cluster**.
1. Click on **Create with Google Kubernetes Engine**. 1. Click on **Create with Google Kubernetes Engine**.
1. Connect your Google account if you haven't done already by clicking the 1. Connect your Google account if you haven't done already by clicking the
**Sign in with Google** button. **Sign in with Google** button.
1. Fill in the requested values: 1. From there on, choose your cluster's settings:
- **Kubernetes cluster name** - The name you wish to give the cluster. - **Kubernetes cluster name** - The name you wish to give the cluster.
- **Environment scope** - The [associated environment](#setting-the-environment-scope) to this cluster. - **Environment scope** - The [associated environment](#setting-the-environment-scope) to this cluster.
- **Google Cloud Platform project** - The project you created in your GCP - **Google Cloud Platform project** - Choose the project you created in your GCP
console that will host the Kubernetes cluster. This must **not** be confused console that will host the Kubernetes cluster. Learn more about
with the project ID. Learn more about [Google Cloud Platform projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects). [Google Cloud Platform projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects).
- **Zone** - The [zone](https://cloud.google.com/compute/docs/regions-zones/) - **Zone** - Choose the [region zone](https://cloud.google.com/compute/docs/regions-zones/)
under which the cluster will be created. under which the cluster will be created.
- **Number of nodes** - The number of nodes you wish the cluster to have. - **Number of nodes** - Enter the number of nodes you wish the cluster to have.
- **Machine type** - The [machine type](https://cloud.google.com/compute/docs/machine-types) - **Machine type** - The [machine type](https://cloud.google.com/compute/docs/machine-types)
of the Virtual Machine instance that the cluster will be based on. of the Virtual Machine instance that the cluster will be based on.
1. Finally, click the **Create Kubernetes cluster** button. 1. Finally, click the **Create Kubernetes cluster** button.
After a few moments, your cluster should be created. If something goes wrong, After a couple of minutes, your cluster will be ready to go. You can now proceed
you will be notified. to install some [pre-defined applications](#installing-applications).
You can now proceed to install some pre-defined applications and then
enable the Cluster integration.
## Adding an existing Kubernetes cluster ## Adding an existing Kubernetes cluster
NOTE: **Note:**
You need Maintainer [permissions] and above to access the Kubernetes page.
To add an existing Kubernetes cluster to your project: To add an existing Kubernetes cluster to your project:
1. Navigate to your project's **Operations > Kubernetes** page. 1. Navigate to your project's **Operations > Kubernetes** page.
NOTE: **Note:**
You need Maintainer [permissions] and above to access the Kubernetes page.
1. Click on **Add Kubernetes cluster**. 1. Click on **Add Kubernetes cluster**.
1. Click on **Add an existing Kubernetes cluster** and fill in the details: 1. Click on **Add an existing Kubernetes cluster** and fill in the details:
- **Kubernetes cluster name** (required) - The name you wish to give the cluster. - **Kubernetes cluster name** (required) - The name you wish to give the cluster.
...@@ -91,9 +98,8 @@ To add an existing Kubernetes cluster to your project: ...@@ -91,9 +98,8 @@ To add an existing Kubernetes cluster to your project:
to create one. You can also view or create service tokens in the to create one. You can also view or create service tokens in the
[Kubernetes dashboard](https://kubernetes.io/docs/tasks/access-application-cluster/web-ui-dashboard/#config) [Kubernetes dashboard](https://kubernetes.io/docs/tasks/access-application-cluster/web-ui-dashboard/#config)
(under **Config > Secrets**). (under **Config > Secrets**).
- **Project namespace** (optional) - The following apply: - **Project namespace** (optional) - You don't have to fill it in; by leaving
- By default you don't have to fill it in; by leaving it blank, GitLab will it blank, GitLab will create one for you. Also:
create one for you.
- Each project should have a unique namespace. - Each project should have a unique namespace.
- The project namespace is not necessarily the namespace of the secret, if - The project namespace is not necessarily the namespace of the secret, if
you're using a secret with broader permissions, like the secret from `default`. you're using a secret with broader permissions, like the secret from `default`.
...@@ -103,11 +109,8 @@ To add an existing Kubernetes cluster to your project: ...@@ -103,11 +109,8 @@ To add an existing Kubernetes cluster to your project:
be the same. be the same.
1. Finally, click the **Create Kubernetes cluster** button. 1. Finally, click the **Create Kubernetes cluster** button.
After a few moments, your cluster should be created. If something goes wrong, After a couple of minutes, your cluster will be ready to go. You can now proceed
you will be notified. to install some [pre-defined applications](#installing-applications).
You can now proceed to install some pre-defined applications and then
enable the Kubernetes cluster integration.
## Security implications ## Security implications
...@@ -152,9 +155,9 @@ added directly to your configured cluster. Those applications are needed for ...@@ -152,9 +155,9 @@ added directly to your configured cluster. Those applications are needed for
| Application | GitLab version | Description | | Application | GitLab version | Description |
| ----------- | :------------: | ----------- | | ----------- | :------------: | ----------- |
| [Helm Tiller](https://docs.helm.sh/) | 10.2+ | Helm is a package manager for Kubernetes and is required to install all the other applications. It will be automatically installed as a dependency when you try to install a different app. It is installed in its own pod inside the cluster which can run the `helm` CLI in a safe environment. | | [Helm Tiller](https://docs.helm.sh/) | 10.2+ | Helm is a package manager for Kubernetes and is required to install all the other applications. It is installed in its own pod inside the cluster which can run the `helm` CLI in a safe environment. |
| [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) | 10.2+ | Ingress can provide load balancing, SSL termination, and name-based virtual hosting. It acts as a web proxy for your applications and is useful if you want to use [Auto DevOps] or deploy your own web apps. | | [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) | 10.2+ | Ingress can provide load balancing, SSL termination, and name-based virtual hosting. It acts as a web proxy for your applications and is useful if you want to use [Auto DevOps] or deploy your own web apps. |
| [Prometheus](https://prometheus.io/docs/introduction/overview/) | 10.4+ | Prometheus is an open-source monitoring and alerting system useful to supervise your deployed applications | | [Prometheus](https://prometheus.io/docs/introduction/overview/) | 10.4+ | Prometheus is an open-source monitoring and alerting system useful to supervise your deployed applications. |
| [GitLab Runner](https://docs.gitlab.com/runner/) | 10.6+ | GitLab Runner is the open source project that is used to run your jobs and send the results back to GitLab. It is used in conjunction with [GitLab CI/CD](https://about.gitlab.com/features/gitlab-ci-cd/), the open-source continuous integration service included with GitLab that coordinates the jobs. When installing the GitLab Runner via the applications, it will run in **privileged mode** by default. Make sure you read the [security implications](#security-implications) before doing so. | | [GitLab Runner](https://docs.gitlab.com/runner/) | 10.6+ | GitLab Runner is the open source project that is used to run your jobs and send the results back to GitLab. It is used in conjunction with [GitLab CI/CD](https://about.gitlab.com/features/gitlab-ci-cd/), the open-source continuous integration service included with GitLab that coordinates the jobs. When installing the GitLab Runner via the applications, it will run in **privileged mode** by default. Make sure you read the [security implications](#security-implications) before doing so. |
| [JupyterHub](http://jupyter.org/) | 11.0+ | [JupyterHub](https://jupyterhub.readthedocs.io/en/stable/) is a multi-user service for managing notebooks across a team. [Jupyter Notebooks](https://jupyter-notebook.readthedocs.io/en/latest/) provide a web-based interactive programming environment used for data analysis, visualization, and machine learning. **Note**: Authentication will be enabled for any user of the GitLab server via OAuth2. HTTPS will be supported in a future release. | | [JupyterHub](http://jupyter.org/) | 11.0+ | [JupyterHub](https://jupyterhub.readthedocs.io/en/stable/) is a multi-user service for managing notebooks across a team. [Jupyter Notebooks](https://jupyter-notebook.readthedocs.io/en/latest/) provide a web-based interactive programming environment used for data analysis, visualization, and machine learning. **Note**: Authentication will be enabled for any user of the GitLab server via OAuth2. HTTPS will be supported in a future release. |
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment