kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/user/project/clusters/serverless/index.md
danielgruesso 417bc01dd3 add images and url retrieval section
2018-11-09 16:48:46 -05:00

5.6 KiB
Raw Blame History

Serverless

Introduced in GitLab 11.5.

Run serverless workloads on Kubernetes using Knative.

Overview

Knative extends Kubernetes to provide a set of middleware components that are useful to build modern, source-centric, and container-based applications. Knative brings some significant benefits out of the box through its main components:

  • Build: Source-to-container build orchestration
  • Eventing: Management and delivery of events
  • Serving: Request-driven compute that can scale to zero

For more information on Knative, visit the Knative docs repo.

Requirements

To run Knative on Gitlab, you will need:

  1. Kubernetes: An RBAC-enabled Kubernetes cluster is required to deploy Knative. The simplest way to get started is to add a cluster using GitLab's GKE integration. GitLab recommends
  2. Helm Tiller: 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.
  3. Domain Name: Knative will provide its own load balancer using Istio. It will provide an external IP address for all the applications served by Knative. You will be prompted to enter a wildcard domain where your applications will be served. Configure your DNS server to use the external IP address for that domain.
  4. Serverless gitlab-ci.yml Template: GitLab uses the TriggerMesh CLI, a serverless resource management utilty to work with knative objects. The gitlab-ci.yml template uses it to build and deploy knative services and functions. Access the template here.
  5. Docker File: Knative requires a docker file in order to build your application. It should be included at the root of your project's repo.

Installing Knative via GitLab's Kubernetes integration

NOTE: Note: Minimum recommended cluster size to run Knative is 3-nodes, 6 vCPUs, and 22.50 GB memory. RBAC must be enabled.

You may download the sample Knative Ruby App to get started.

  1. Add a Kubernetes cluster and install Helm.

  2. Once Helm has been successfully installed, on the Knative app section, enter the domain to be used with your application and click "Install".

    install-knative

  3. After the Knative installation has finished, retrieve the Istio Ingress IP address by running the following command:

    kubectl get svc --namespace=istio-system knative-ingressgateway -o jsonpath='{.status.loadBalancer.ingress[0].ip} '

  4. The ingress is now available at this address and will route incoming requests to the proper service based on the DNS name in the request. To support this, a wildcard DNS A record should be created for the desired domain name.

    dns entry

Deploying the GitLab Runner (optional)

If the project is on GitLab.com, free shared runners are available and you do not have to deploy one. If a project specific runner is desired, or there are no shared runners, it is easy to deploy one.

Simply click on the "Install" button for the GitLab Runner. It is important to note that the runner deployed is set as privileged, which means it essentially has root access to the underlying machine. This is required to build docker images, and so is on by default.

Deploy the application with Knative

With all the pieces in place, you can simply create a new CI pipeline to deploy the Knative application. Navigate to CI/CD >> Pipelines and click on the "Run Pipeline" button on the upper right hand side of the screen. On the Pipelines page now click "Create pipeline".

Obtain the URL for the Knative deployment

Once all the stages of the pipeline finish, click on the "deploy" stage

deploy stage

The output will look like this:

Running with gitlab-runner 11.5.0~beta.844.g96d88322 (96d88322)
  on docker-auto-scale 72989761
Using Docker executor with image gcr.io/triggermesh/tm@sha256:e3ee74db94d215bd297738d93577481f3e4db38013326c90d57f873df7ab41d5 ...
Pulling docker image gcr.io/triggermesh/tm@sha256:e3ee74db94d215bd297738d93577481f3e4db38013326c90d57f873df7ab41d5 ...
Using docker image sha256:6b3f6590a9b30bd7aafb9573f047d930c70066e43955b4beb18a1eee175f6de1 for gcr.io/triggermesh/tm@sha256:e3ee74db94d215bd297738d93577481f3e4db38013326c90d57f873df7ab41d5 ...
Running on runner-72989761-project-4342902-concurrent-0 via runner-72989761-stg-srm-1541795796-27929c96...
Cloning repository...
Cloning into '/builds/danielgruesso/knative'...
Checking out 8671ad20 as master...
Skipping Git submodules setup
$ echo "$CI_REGISTRY_IMAGE"
registry.staging.gitlab.com/danielgruesso/knative
$ tm -n "$KUBE_NAMESPACE" --config "$KUBECONFIG" deploy service "$CI_PROJECT_NAME" --from-image "$CI_REGISTRY_IMAGE" --wait
Deployment started. Run "tm -n knative-4342902 describe service knative" to see the details
Waiting for ready state.......
Service domain: knative.knative-4342902.knative.info
Job succeeded

The second to last line, labeled "Service domain" contains the URL for the deployment. Copy and paste the domain into your browser to see the app live.

knative app