diff options
Diffstat (limited to 'doc/user/project')
-rw-r--r-- | doc/user/project/clusters/add_remove_clusters.md | 16 | ||||
-rw-r--r-- | doc/user/project/clusters/index.md | 8 | ||||
-rw-r--r-- | doc/user/project/clusters/serverless/index.md | 94 |
3 files changed, 63 insertions, 55 deletions
diff --git a/doc/user/project/clusters/add_remove_clusters.md b/doc/user/project/clusters/add_remove_clusters.md index a77584c0485..7aeb4c4cf91 100644 --- a/doc/user/project/clusters/add_remove_clusters.md +++ b/doc/user/project/clusters/add_remove_clusters.md @@ -1,10 +1,12 @@ # Adding and removing Kubernetes clusters -GitLab can integrate with the following Kubernetes providers: +GitLab offers integrated cluster creation for the following Kubernetes providers: - Google Kubernetes Engine (GKE). - Amazon Elastic Kubernetes Service (EKS). +In addition, GitLab can integrate with any standard Kubernetes provider, either on-premise or hosted. + 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 @@ -360,18 +362,20 @@ to install some [pre-defined applications](index.md#installing-applications). ## Add existing cluster -If you have either of the following types of clusters already, you can add them to a project: +If you have an existing Kubernetes cluster, you can add it to a project, group, or instance. + +For more information, see information for adding an: -- [Google Kubernetes Engine cluster](#existing-gke-cluster). -- [Amazon Elastic Kubernetes Service](#existing-eks-cluster). +- [Existing Kubernetes cluster](#existing-kubernetes-cluster). +- [Existing Elastic Kubernetes Service cluster](#existing-eks-cluster). NOTE: **Note:** Kubernetes integration is not supported for arm64 clusters. See the issue [Helm Tiller fails to install on arm64 cluster](https://gitlab.com/gitlab-org/gitlab-foss/issues/64044) for details. -### Existing GKE cluster +### Existing Kubernetes cluster -To add an existing GKE cluster to your project, group, or instance: +To add a Kubernetes cluster to your project, group, or instance: 1. Navigate to your: - Project's **Operations > Kubernetes** page, for a project-level cluster. diff --git a/doc/user/project/clusters/index.md b/doc/user/project/clusters/index.md index 895cc6c4b57..b78dcf615c8 100644 --- a/doc/user/project/clusters/index.md +++ b/doc/user/project/clusters/index.md @@ -96,8 +96,12 @@ to the first container in the first pod of your environment. ## Adding and removing clusters -See [Adding and removing Kubernetes clusters](add_remove_clusters.md) for details on how to -set up integrations with Google Cloud Platform (GCP) and Amazon Elastic Kubernetes Service (EKS). +See [Adding and removing Kubernetes clusters](add_remove_clusters.md) for details on how +to: + +- Create a cluster in Google Cloud Platform (GCP) or Amazon Elastic Kubernetes Service + (EKS) using GitLab's UI. +- Add an integration to an existing cluster from any Kubernetes platform. ## Cluster configuration diff --git a/doc/user/project/clusters/serverless/index.md b/doc/user/project/clusters/serverless/index.md index 1dc543c3b83..9b56970db53 100644 --- a/doc/user/project/clusters/serverless/index.md +++ b/doc/user/project/clusters/serverless/index.md @@ -170,53 +170,6 @@ You must do the following: or [serverless applications](#deploying-serverless-applications) onto your cluster. -## Configuring logging - -> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/33330) in GitLab 12.5. - -### Prerequisites - -- A GitLab-managed cluster. -- `kubectl` installed and working. - -Running `kubectl` commands on your cluster requires setting up access to the -cluster first. For clusters created on: - -- GKE, see [GKE Cluster Access](https://cloud.google.com/kubernetes-engine/docs/how-to/cluster-access-for-kubectl) -- Other platforms, see [Install and Set Up kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/). - -### Enable request log template - -Run the following command to enable request logs: - -```shell -kubectl edit cm -n knative-serving config-observability -``` - -Copy the `logging.request-log-template` from the `data._example` field to the data field one level up in the hierarchy. - -### Enable request logs - -Run the following commands to install Elasticsearch, Kibana, and Filebeat into a `kube-logging` namespace and configure all nodes to forward logs using Filebeat: - -```shell -kubectl apply -f https://gitlab.com/gitlab-org/serverless/configurations/knative/raw/v0.7.0/kube-logging-filebeat.yaml -kubectl label nodes --all beta.kubernetes.io/filebeat-ready="true" -``` - -### Viewing request logs - -To view request logs: - -1. Run `kubectl proxy`. -1. Navigate to Kibana UI. - -Or: - -1. Open the Kibana UI. -1. Click on **Discover**, then select `filebeat-*` from the dropdown on the left. -1. Enter `kubernetes.container.name:"queue-proxy" AND message:/httpRequest/` into the search box. - ## Supported runtimes Serverless functions for GitLab can be run using: @@ -559,6 +512,53 @@ deployment. Copy and paste the domain into your browser to see the app live. ![knative app](img/knative-app.png) +## Configuring logging + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/33330) in GitLab 12.5. + +### Prerequisites + +- A GitLab-managed cluster. +- `kubectl` installed and working. + +Running `kubectl` commands on your cluster requires setting up access to the +cluster first. For clusters created on: + +- GKE, see [GKE Cluster Access](https://cloud.google.com/kubernetes-engine/docs/how-to/cluster-access-for-kubectl) +- Other platforms, see [Install and Set Up kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/). + +### Enable request log template + +Run the following command to enable request logs: + +```shell +kubectl edit cm -n knative-serving config-observability +``` + +Copy the `logging.request-log-template` from the `data._example` field to the data field one level up in the hierarchy. + +### Enable request logs + +Run the following commands to install Elasticsearch, Kibana, and Filebeat into a `kube-logging` namespace and configure all nodes to forward logs using Filebeat: + +```shell +kubectl apply -f https://gitlab.com/gitlab-org/serverless/configurations/knative/raw/v0.7.0/kube-logging-filebeat.yaml +kubectl label nodes --all beta.kubernetes.io/filebeat-ready="true" +``` + +### Viewing request logs + +To view request logs: + +1. Run `kubectl proxy`. +1. Navigate to [Kibana UI](http://localhost:8001/api/v1/namespaces/kube-logging/services/kibana/proxy/app/kibana). + +Or: + +1. Open the [Kibana UI](http://localhost:8001/api/v1/namespaces/kube-logging/services/kibana/proxy/app/kibana). +1. Click on **Discover**, then select `filebeat-*` from the dropdown on the left. +1. Enter `kubernetes.container.name:"queue-proxy" AND message:/httpRequest/` into the search box. + ## Function details Go to the **Operations > Serverless** page and click on one of the function |