diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-12-10 00:11:06 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-12-10 00:11:06 +0300 |
commit | 85e524e496ae52652c541e98d5837b7c04bd2607 (patch) | |
tree | e67091bc91cac62f2fb49725f084ea55fab2c3fb /doc/development | |
parent | f6115a0f2ce347bab74ff5951cf828196d715b66 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development')
-rw-r--r-- | doc/development/architecture.md | 10 | ||||
-rw-r--r-- | doc/development/documentation/workflow.md | 96 | ||||
-rw-r--r-- | doc/development/features_inside_dot_gitlab.md | 2 | ||||
-rw-r--r-- | doc/development/go_guide/go_upgrade.md | 2 | ||||
-rw-r--r-- | doc/development/internal_api/index.md | 26 |
5 files changed, 65 insertions, 71 deletions
diff --git a/doc/development/architecture.md b/doc/development/architecture.md index 38d0d5d7843..078eb5dd0de 100644 --- a/doc/development/architecture.md +++ b/doc/development/architecture.md @@ -126,7 +126,7 @@ graph LR Geo -- TCP 22 --> SSH Geo -- TCP 5432 --> PostgreSQL Runner{{GitLab Runner}} -- TCP 443 --> HTTP - K8sAgent{{GitLab Kubernetes Agent}} -- TCP 443 --> HTTP + K8sAgent{{GitLab Agent}} -- TCP 443 --> HTTP %% GitLab Application Suite subgraph GitLab @@ -157,7 +157,7 @@ graph LR Puma["Puma (GitLab Rails)"] Puma <--> Registry GitLabWorkhorse[GitLab Workhorse] <--> Puma - GitLabKas[GitLab Kubernetes Agent Server] --> GitLabWorkhorse + GitLabKas[GitLab Agent Server] --> GitLabWorkhorse GitLabPages[GitLab Pages] --> GitLabWorkhorse Mailroom Sidekiq @@ -349,7 +349,7 @@ Component statuses are linked to configuration documentation for each component. | [GitLab Exporter](#gitlab-exporter) | Generates a variety of GitLab metrics | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | CE & EE | | [GitLab Geo Node](#gitlab-geo) | Geographically distributed GitLab nodes | ⚙ | ⚙ | ❌ | ❌ | ✅ | ❌ | ⚙ | EE Only | | [GitLab Pages](#gitlab-pages) | Hosts static websites | ⚙ | ⚙ | ❌ | ❌ | ✅ | ⚙ | ⚙ | CE & EE | -| [GitLab Kubernetes Agent](#gitlab-kubernetes-agent) | Integrate Kubernetes clusters in a cloud-native way | ⚙ | ⚙ | ⚙ | ❌ | ❌ | ⤓ | ⚙ | EE Only | +| [GitLab Agent](#gitlab-agent) | Integrate Kubernetes clusters in a cloud-native way | ⚙ | ⚙ | ⚙ | ❌ | ❌ | ⤓ | ⚙ | EE Only | | [GitLab self-monitoring: Alertmanager](#alertmanager) | Deduplicates, groups, and routes alerts from Prometheus | ⚙ | ⚙ | ✅ | ⚙ | ✅ | ❌ | ❌ | CE & EE | | [GitLab self-monitoring: Grafana](#grafana) | Metrics dashboard | ✅ | ✅ | ⚙ | ⤓ | ✅ | ❌ | ⚙ | CE & EE | | [GitLab self-monitoring: Jaeger](#jaeger) | View traces generated by the GitLab instance | ❌ | ⚙ | ⚙ | ❌ | ❌ | ⤓ | ⚙ | CE & EE | @@ -499,14 +499,14 @@ Geo is a premium feature built to help speed up the development of distributed t GitLab Exporter is a process designed in house that allows us to export metrics about GitLab application internals to Prometheus. You can read more [in the project's README](https://gitlab.com/gitlab-org/gitlab-exporter). -#### GitLab Kubernetes Agent +#### GitLab Agent - [Project page](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent) - Configuration: - [Omnibus](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/files/gitlab-config-template/gitlab.rb.template) - [Charts](https://docs.gitlab.com/charts/charts/gitlab/kas/index.html) -[GitLab Kubernetes Agent](../user/clusters/agent/index.md) is an active in-cluster +The [GitLab Agent](../user/clusters/agent/index.md) is an active in-cluster component for solving GitLab and Kubernetes integration tasks in a secure and cloud-native way. diff --git a/doc/development/documentation/workflow.md b/doc/development/documentation/workflow.md index 48428edfab1..49ad51874e3 100644 --- a/doc/development/documentation/workflow.md +++ b/doc/development/documentation/workflow.md @@ -4,66 +4,44 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Documentation process +# How to update GitLab documentation -The process for creating and maintaining GitLab product documentation allows -anyone to contribute a merge request or create an issue for GitLab -documentation. - -Documentation updates relating to new features or feature enhancements must -use the [feature workflow process](https://about.gitlab.com/handbook/engineering/ux/technical-writing/workflow/#for-a-product-change) described in the GitLab Handbook. - -## Who updates the docs? - -*Anyone* can contribute! You can create a merge request for documentation when: +Anyone can contribute to the GitLab documentation! You can create a merge request for documentation when: - You find errors or other room for improvement in existing documentation. - You have an idea for all-new documentation that would help a GitLab user or administrator to accomplish their work with GitLab. -## Documentation labels - -Regardless of the type of issue or merge request, certain labels are required when documentation -is added or updated. The following are added by the issue or merge request author: - -- An appropriate [type label](../contributing/issue_workflow.md#type-labels). -- The [stage label](../contributing/issue_workflow.md#stage-labels) and - [group label](../contributing/issue_workflow.md#group-labels). For example, `~devops::create` and - `~group::source code`. -- The `~documentation` [specialization label](../contributing/issue_workflow.md#specialization-labels). - -The following are also added by members of the Technical Writing team: - -- A documentation [scoped label](../../user/project/labels.md#scoped-labels) with the - `docs::` prefix. For example, `~docs::improvement`. -- The `~Technical Writing` [team label](../contributing/issue_workflow.md#team-labels). - -Documentation changes that are not associated with the release of a new or updated feature -do not take the `~"type::feature"` label, but still need the `~documentation` label. - -They may include: - -- Documentation created or updated to improve accuracy, completeness, ease of use, or any reason - other than a [feature change](https://about.gitlab.com/handbook/engineering/ux/technical-writing/workflow/#for-a-product-change). -- Addressing gaps in existing documentation, or making improvements to existing documentation. -- Work on special projects related to the documentation. +If you are working on a feature or enhancement, use the +[feature workflow process described in the GitLab Handbook](https://about.gitlab.com/handbook/engineering/ux/technical-writing/workflow/#for-a-product-change). ## How to update the docs -To update GitLab documentation: - -1. Either: - - Click the **Edit this Page** link at the bottom of any page on <https://docs.gitlab.com>. - - Navigate to one of the repositories and documentation paths listed on the - [GitLab Documentation guidelines](index.md) page. -1. Follow the described standards and processes listed on the page, including: - - The [Structure and template](structure.md) page. - - The [Style Guide](styleguide/index.md). - - The [Markdown Guide](https://about.gitlab.com/handbook/markdown-guide/). -1. Follow the [Merge Request Guidelines](../contributing/merge_request_workflow.md#merge-request-guidelines). - -NOTE: -Work in a fork if you do not have the Developer role in the GitLab project. +If you are not a GitLab team member, or do not have the Developer role for the GitLab repository, to update GitLab documentation: + +1. Select an issue you'd like to work on. + - You don't need an issue to open a merge request. + - For a Hackathon, in the issue, in a comment, mention the person who opened the issue and ask for the issue to be assigned to you. + To be fair to other contributors, if you see someone has already asked to work on the issue, choose another issue. + If you are looking for issues to work on and don't see any that suit you, you can always fix [Vale](testing.md#vale) issues. +1. Go to the [GitLab repository](https://gitlab.com/gitlab-org/gitlab). +1. In the top-right, select **Fork**. Forking makes a copy of the repository on GitLab.com. +1. In your fork, find the documentation page by going to the `\doc` directory. +1. If you know Git, make your changes and open a merge request. + If not, follow these steps: + 1. In the top right, select **Edit**, make the changes, and **Save**. + 1. From the left menu, select **Merge requests**. + 1. For the source branch, select your fork and branch. If you did not create a branch, select `master`. + For the target branch, select the [GitLab repository](https://gitlab.com/gitlab-org/gitlab) `master` branch. + 1. For the commit message, use 3-5 words, start with a capital letter, and do not end with a period. + 1. Select **Commit changes**. A merge request opens. + 1. Select the **Documentation** template. In the description, write a brief summary of the changes and link to the related issue, if there is one. + +If you need help while working on the page, view: + +- The [Style Guide](styleguide/index.md). +- The [Word list](styleguide/word_list.md) +- The [Markdown Guide](https://about.gitlab.com/handbook/markdown-guide/). ### Ask for help @@ -83,6 +61,22 @@ To identify someone who can help you: If you are a member of the GitLab Slack workspace, you can request help in `#docs`. +## Documentation labels + +When you author an issue or merge request, you must add these labels: + +- A [type label](../contributing/issue_workflow.md#type-labels). +- A [stage label](../contributing/issue_workflow.md#stage-labels) and [group label](../contributing/issue_workflow.md#group-labels). + For example, `~devops::create` and `~group::source code`. +- A `~documentation` [specialization label](../contributing/issue_workflow.md#specialization-labels). + +A member of the Technical Writing team adds these labels: + +- A [documentation scoped label](../../user/project/labels.md#scoped-labels) with the + `docs::` prefix. For example, `~docs::improvement`. +- The [`~Technical Writing` team label](../contributing/issue_workflow.md#team-labels). +- A type label: either `~"type::feature"` or `~"type::maintenance"`. + ### Reviewing and merging Anyone with the [Maintainer role](../../user/permissions.md) to the relevant GitLab project can diff --git a/doc/development/features_inside_dot_gitlab.md b/doc/development/features_inside_dot_gitlab.md index 4631ab3a471..3a9decaad69 100644 --- a/doc/development/features_inside_dot_gitlab.md +++ b/doc/development/features_inside_dot_gitlab.md @@ -12,7 +12,7 @@ When implementing new features, please refer to these existing features to avoid - [Custom Dashboards](../operations/metrics/dashboards/index.md#add-a-new-dashboard-to-your-project): `.gitlab/dashboards/`. - [Issue Templates](../user/project/description_templates.md#create-an-issue-template): `.gitlab/issue_templates/`. - [Merge Request Templates](../user/project/description_templates.md#create-a-merge-request-template): `.gitlab/merge_request_templates/`. -- [GitLab Kubernetes Agents](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/blob/master/doc/configuration_repository.md#layout): `.gitlab/agents/`. +- [GitLab Agent](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/blob/master/doc/configuration_repository.md#layout): `.gitlab/agents/`. - [CODEOWNERS](../user/project/code_owners.md#set-up-code-owners): `.gitlab/CODEOWNERS`. - [Route Maps](../ci/review_apps/#route-maps): `.gitlab/route-map.yml`. - [Customize Auto DevOps Helm Values](../topics/autodevops/customize.md#customize-values-for-helm-chart): `.gitlab/auto-deploy-values.yaml`. diff --git a/doc/development/go_guide/go_upgrade.md b/doc/development/go_guide/go_upgrade.md index 53f2d7d176a..cde2ee39e3c 100644 --- a/doc/development/go_guide/go_upgrade.md +++ b/doc/development/go_guide/go_upgrade.md @@ -134,7 +134,7 @@ if you need help finding the correct person or labels: | GitLab Compose Kit | [Issuer Tracker](https://gitlab.com/gitlab-org/gitlab-compose-kit/-/issues) | | GitLab Container Registry | [Issue Tracker](https://gitlab.com/gitlab-org/container-registry) | | GitLab Elasticsearch Indexer | [Issue Tracker](https://gitlab.com/gitlab-org/gitlab-elasticsearch-indexer/-/issues) | -| GitLab Kubernetes Agent (KAS) | [Issue Tracker](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/issues) | +| GitLab Agent Server (KAS) | [Issue Tracker](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/issues) | | GitLab Pages | [Issue Tracker](https://gitlab.com/gitlab-org/gitlab-pages/-/issues) | | GitLab Quality Images | [Issue Tracker](https://gitlab.com/gitlab-org/gitlab-build-images/-/issues) | | GitLab Shell | [Issue Tracker](https://gitlab.com/gitlab-org/gitlab-shell/-/issues) | diff --git a/doc/development/internal_api/index.md b/doc/development/internal_api/index.md index 0fe9a5362cf..543c5f40f88 100644 --- a/doc/development/internal_api/index.md +++ b/doc/development/internal_api/index.md @@ -42,7 +42,7 @@ file, and include the token Base64 encoded in a `secret_token` parameter or in the `Gitlab-Shared-Secret` header. NOTE: -The internal API used by GitLab Pages, and GitLab Kubernetes Agent Server (`kas`) uses JSON Web Token (JWT) +The internal API used by GitLab Pages, and GitLab Agent Server (`kas`) uses JSON Web Token (JWT) authentication, which is different from GitLab Shell. ## Git Authentication @@ -400,13 +400,13 @@ Example response: } ``` -## Kubernetes agent endpoints +## GitLab Agent endpoints > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/41045) in GitLab 13.4. > - This feature is not deployed on GitLab.com > - It's not recommended for production use. -The following endpoints are used by the GitLab Kubernetes Agent Server (`kas`) +The following endpoints are used by the GitLab Agent Server (`kas`) for various purposes. These endpoints are all authenticated using JWT. The JWT secret is stored in a file @@ -414,11 +414,11 @@ specified in `config/gitlab.yml`. By default, the location is in the root of the GitLab Rails app in a file called `.gitlab_kas_secret`. WARNING: -The Kubernetes agent is under development and is not recommended for production use. +The GitLab Agent is under development and is not recommended for production use. -### Kubernetes agent information +### GitLab Agent information -Called from GitLab Kubernetes Agent Server (`kas`) to retrieve agent +Called from GitLab Agent Server (`kas`) to retrieve agent information for the given agent token. This returns the Gitaly connection information for the agent's project in order for `kas` to fetch and update the agent's configuration. @@ -434,9 +434,9 @@ curl --request GET --header "Gitlab-Kas-Api-Request: <JWT token>" \ --header "Authorization: Bearer <agent token>" "http://localhost:3000/api/v4/internal/kubernetes/agent_info" ``` -### Kubernetes agent project information +### GitLab Agent project information -Called from GitLab Kubernetes Agent Server (`kas`) to retrieve project +Called from GitLab Agent Server (`kas`) to retrieve project information for the given agent token. This returns the Gitaly connection for the requested project. GitLab `kas` uses this to configure the agent to fetch Kubernetes resources from the project repository to @@ -460,9 +460,9 @@ curl --request GET --header "Gitlab-Kas-Api-Request: <JWT token>" \ --header "Authorization: Bearer <agent token>" "http://localhost:3000/api/v4/internal/kubernetes/project_info?id=7" ``` -### Kubernetes agent usage metrics +### GitLab Agent usage metrics -Called from GitLab Kubernetes Agent Server (`kas`) to increase the usage +Called from GitLab Agent Server (`kas`) to increase the usage metric counters. | Attribute | Type | Required | Description | @@ -481,9 +481,9 @@ curl --request POST --header "Gitlab-Kas-Api-Request: <JWT token>" --header "Con --data '{"gitops_sync_count":1}' "http://localhost:3000/api/v4/internal/kubernetes/usage_metrics" ``` -### Kubernetes agent alert metrics +### GitLab Agent alert metrics -Called from GitLab Kubernetes Agent Server (KAS) to save alerts derived from Cilium on Kubernetes +Called from GitLab Agent Server (KAS) to save alerts derived from Cilium on Kubernetes Cluster. | Attribute | Type | Required | Description | @@ -505,7 +505,7 @@ curl --request POST --header "Gitlab-Kas-Api-Request: <JWT token>" \ ### Create Starboard vulnerability -Called from the GitLab Kubernetes Agent Server (`kas`) to create a security vulnerability +Called from the GitLab Agent Server (`kas`) to create a security vulnerability from a Starboard vulnerability report. This request is idempotent. Multiple requests with the same data create a single vulnerability. |