Skip to content

G
gitlab-ce
Commit e53f854f authored by Evan Read's avatar Evan Read
Browse files
Options

Port WIP changes from CE landing page to EE 

Also:

- Add EE-specific links that were already in EE landing page.
- Add descriptions to links where none existed.
parent b875431f
Hide whitespace changes
Inline Side-by-side
Showing with 461 additions and 204 deletions
doc/README.md
View file @ e53f854f
...@@ -5,157 +5,273 @@ description: 'Learn how to use and administer GitLab, the most scalable Git-base ...@@ -5,157 +5,273 @@ description: 'Learn how to use and administer GitLab, the most scalable Git-base
# GitLab Documentation # GitLab Documentation
Welcome to [GitLab](https://about.gitlab.com/), a Git-based fully featured Welcome to [GitLab](https://about.gitlab.com/) Documentation.
platform for software development!
Here you can access the complete documentation for GitLab, the single application for the
[entire DevOps lifecycle](#complete-devops-with-gitlab).
## Overview
No matter how you use GitLab, we have documentation for you.
<table>
<tbody>
<tr>
<td width="50%">
<a href="user/index.md"><strong>User documentation</strong></a>
<br/>
Discover features and concepts for GitLab users.
</td>
<td width="50%">
<a href="administration/index.md"><strong>Administrator documentation</strong></a>
<br/>
Everything GitLab administrators need to know.
</td>
</tr>
<tr>
<td width="50%">
<a href="#contributing-to-gitlab"><strong>Contributing to GitLab</strong></a>
<br/>
At GitLab, everyone can contribute!
</td>
<td width="50%">
<a href="#new-to-git-and-gitlab"><strong>New to Git and GitLab?</strong></a>
<br/>
We have resources to get you started.
</td>
</tr>
<tr>
<td width="50%">
<a href="#building-an-integration-with-gitlab"><strong>Building an integration with GitLab?</strong></a>
<br/>
Consult our our automation and integration documentation.
</td>
<td width="50%">
<a href="#coming-to-gitlab-from-another-platform"><strong>Coming to GitLab from another platform?</strong></a>
<br/>
Consult our handy guides.
</td>
</tr>
</tbody>
</table>
## Popular Documentation
Have a look at some of our most popular documentation resources:
| Popular Topic | Description |
|:----------------------------------------------------------------|:-----------------------------------------------------------------|
| [Configuring `.gitlab-ci.yml`](ci/yaml/README.md) | Complete syntax documentation for configuring your CI pipelines. |
| [GitLab CI/CD examples](ci/examples/README.md) | Get up to speed quickly with common CI/CD scenarios. |
| [GitLab Container Registry](user/project/container_registry.md) | Host containers within GitLab. |
| [GitLab Pages](user/project/pages/index.md) | Host static websites for your projects with GitLab. |
| [Kubernetes integration](user/project/clusters/index.md) | Use GitLab with Kubernetes. |
| [SSH authentication](ssh/README.md) | Secure your network communications. |
| [Using Docker images](ci/docker/using_docker_images.md) | Build and test your applications with Docker. |
GitLab offers the most scalable Git-based fully integrated platform for ## Complete DevOps with GitLab
software development, with flexible products and subscriptions.
To understand what features you have access to, check the [GitLab subscriptions](#gitlab-subscriptions) below.
**Shortcuts to GitLab's most visited docs:** GitLab is the first single application for software development, security,
and operations that enables [Concurrent DevOps](https://about.gitlab.com/concurrent-devops/),
making the software lifecycle faster and radically improving the speed of business.
| General documentation | GitLab CI/CD docs | GitLab provides solutions for [all the stages of the DevOps lifecycle](https://about.gitlab.com/stages-devops-lifecycle/):
| :----- | :----- |
| [User documentation](user/index.md) | [GitLab CI/CD quick start guide](ci/quick_start/README.md) |
| [Administrator documentation](administration/index.md) | [GitLab CI/CD examples](ci/examples/README.md) |
| [Contributor documentation](#contributor-documentation) | [Configuring `.gitlab-ci.yml`](ci/yaml/README.md) |
| [Getting started with GitLab](#getting-started-with-gitlab) | [Using Docker images](ci/docker/using_docker_images.md) |
| [API](api/README.md) | [Auto DevOps](topics/autodevops/index.md) |
| [SSH authentication](ssh/README.md) | [Kubernetes integration](user/project/clusters/index.md)|
| [GitLab Pages](user/project/pages/index.md) | [GitLab Container Registry](user/project/container_registry.md) |
## Complete DevOps with GitLab <img class="image-noshadow" src="img/devops-stages.png" alt="DevOps Stages">
GitLab is the first single application for software development, security, The following sections provide links to documentation for each DevOps stage:
and operations that enables Concurrent DevOps, making the software lifecycle
three times faster and radically improving the speed of business. GitLab | DevOps Stage | Documentation for |
provides solutions for all the stages of the DevOps lifecycle: |:------------------------|:------------------------------------------------------------|
[plan](#plan), [create](#create), [verify](#verify), [package](#package), | [Manage](#manage) | Statistics and analytics features. |
[release](#release), [configure](#configure), [monitor](#monitor), and | [Plan](#plan) | Project planning and management features. |
[secure](#secure). | [Create](#create) | Source code and data creation and management features. |
| [Verify](#verify) | Testing, code quality, and continuous integration features. |
| [Package](#package) | Docker container registry. |
| [Release](#release) | Application release and delivery features. |
| [Configure](#configure) | Application and infrastructure configuration tools. |
| [Monitor](#monitor) | Application monitoring and metrics features. |
| [Secure](#secure) | Security capability feature. |
<div align="right">
<a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
### Manage
GitLab provides statistics and insight into ways you can maximize the value of GitLab in your organization.
<img class="image-noshadow" src="img/devops_lifecycle.png" alt="DevOps Lifecycle"> The following documentation relates to the DevOps **Manage** stage:
| Manage Topics | Description |
|:------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Authentication and Authorization](administration/auth/README.md) | Supported authentication and authorization providers. |
| [GitLab Cycle Analytics](user/project/cycle_analytics.md) | Measure the time it takes to go from an [idea to production](https://about.gitlab.com/2016/08/05/continuous-integration-delivery-and-deployment-with-gitlab/#from-idea-to-production-with-gitlab) for each project you have. |
| [Instance Statistics](user/instance_statistics/index.md) | Discover statistics on how many GitLab features you use and user activity. |
<div align="right">
<a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
### Plan ### Plan
Whether you use Waterfall, Agile, or Conversational Development, Whether you use Waterfall, Agile, or Conversational Development, GitLab streamlines your collaborative workflows.
GitLab streamlines your collaborative workflows. Visualize, prioritize,
coordinate, and track your progress your way with GitLab’s flexible project Visualize, prioritize, coordinate, and track your progress your way with GitLab’s flexible project
management tools. management tools.
- Chat operations The following documentation relates to the DevOps **Plan** stage:
- [GitLab ChatOps](ci/chatops/README.md) **[ULTIMATE]**
- [Mattermost slash commands](user/project/integrations/mattermost_slash_commands.md) | Plan Topics | Description |
- [Slack slash commands](user/project/integrations/slack_slash_commands.md) |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|
- [Discussions](user/discussions/index.md): Threads, comments, and resolvable discussions in issues, commits, and merge requests. | [Burndown Charts](user/project/milestones/burndown_charts.md) **[STARTER]** | Watch your project's progress throughout a specific milestone. |
- [Issues](user/project/issues/index.md) | [Discussions](user/discussions/index.md) | Threads, comments, and resolvable discussions in issues, commits, and merge requests. |
- [Project Issue Boards](user/project/issue_board.md) | [Due Dates](user/project/issues/due_dates.md) | Keep track of issue deadlines. |
- [Group Issue Boards](user/project/issue_board.md#group-issue-boards) | [Epics](user/group/epics/index.md) **[ULTIMATE]** | Tracking groups of issues that share a theme. |
- [Related Issues](user/project/issues/related_issues.md): create a relationship between issues.**[STARTER]** | [Issues](user/project/issues/index.md), including [confidential issues](user/project/issues/confidential_issues.md), [issue and merge request templates](user/project/description_templates.md), and [moving issues](user/project/issues/moving_issues.md) | Project issues, restricting access to issues, create templates for submitting new issues and merge requests, and moving issues between projects. |
- [Issues and merge requests templates](user/project/description_templates.md): Create templates for submitting new issues and merge requests. | [Labels](user/project/labels.md) | Categorize issues or merge requests with descriptive labels. |
- [Labels](user/project/labels.md): Categorize your issues or merge requests based on descriptive titles. | [Milestones](user/project/milestones/index.md) | Set milestones for delivery of issues and merge requests, with optional due date. |
- [Milestones](user/project/milestones/index.md): Organize issues and merge requests into a cohesive group, optionally setting a due date. | [Project Issue Board](user/project/issue_board.md) | Display issues on a Scrum or Kanban board. |
- [Burndown Charts](user/project/milestones/burndown_charts.md): Watch your project's progress throughout a specific milestone. **[STARTER]** | [Quick Actions](user/project/quick_actions.md) | Shortcuts for common actions on issues or merge requests, replacing the need to click buttons or use dropdowns in GitLab's UI. |
- [Todos](workflow/todos.md): A chronological list of to-dos that are waiting for your input, all in a simple dashboard. | [Related Issues](user/project/issues/related_issues.md) **[STARTER]** | Create a relationship between issues. |
- [GitLab Quick Actions](user/project/quick_actions.md): Textual shortcuts for common actions on issues or merge requests that are usually done by clicking buttons or dropdowns in GitLab's UI. | [Roadmap](user/group/roadmap/index.md) **[ULTIMATE]** | Visualize epic timelines. |
- [Service Desk](user/project/service_desk.md): A simple way to allow people to create issues in your GitLab instance without needing their own user account. **[PREMIUM]** | [Service Desk](user/project/service_desk.md) **[PREMIUM]** | A simple way to allow people to create issues in your GitLab instance without needing their own user account. |
| [Time Tracking](workflow/time_tracking.md) | Track time spent on issues and merge requests. |
#### Migrate and import your projects from other platforms | [Todos](workflow/todos.md) | Keep track of work requiring attention with a chronological list displayed on a simple dashboard. |
- [Importing to GitLab](user/project/import/index.md): Import your projects from GitHub, Bitbucket, GitLab.com, FogBugz and SVN into GitLab. <div align="right">
- [Migrating from SVN](workflow/importing/migrating_from_svn.md): Convert a SVN repository to Git and GitLab. <a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
### Create ### Create
Consolidate source code into a single [DVCS](https://en.wikipedia.org/wiki/Distributed_version_control) Consolidate source code into a single [distributed version control system](https://en.wikipedia.org/wiki/Distributed_version_control)
that’s easily managed and controlled without disrupting your workflow. that’s easily managed and controlled without disrupting your workflow.
GitLab’s git repositories come complete with branching tools and access
GitLab’s Git repositories come complete with branching tools and access
controls, providing a scalable, single source of truth for collaborating controls, providing a scalable, single source of truth for collaborating
on projects and code. on projects and code.
#### Projects and groups The following documentation relates to the DevOps **Create** stage:
- [Projects](user/project/index.md): #### Projects and Groups
- [Project settings](user/project/settings/index.md)
- [Create a project](gitlab-basics/create-project.md) | Create Topics - Projects and Groups | Description |
- [Fork a project](gitlab-basics/fork-project.md) |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------|
- [Importing and exporting projects between instances](user/project/settings/import_export.md). | [Advanced global search](user/search/advanced_global_search.md) **[STARTER]** | Leverage Elasticsearch for faster, more advanced code search across your entire GitLab instance. |
- [Project access](public_access/public_access.md): Setting up your project's visibility to public, internal, or private. | [Advanced syntax search](user/search/advanced_search_syntax.md) **[STARTER]** | Use advanced queries for more targeted search results. |
- [GitLab Pages](user/project/pages/index.md): Build, test, and deploy your static website with GitLab Pages. | [Contribution analytics](user/group/contribution_analytics/index.md) **[STARTER]** | See detailed statistics of group contributors. |
- [Groups](user/group/index.md): Organize your projects in groups. | [Create](gitlab-basics/create-project.md) and [fork](gitlab-basics/fork-project.md) projects, and [import and export projects between instances](user/project/settings/import_export.md) | Create, duplicate, and move projects. |
- [Subgroups](user/group/subgroups/index.md) | [File locking](user/project/file_lock.md) **[PREMIUM]** | Lock files to avoid merge conflicts. |
- [Epics](user/group/epics/index.md) **[ULTIMATE]** | [GitLab Pages](user/project/pages/index.md) | Build, test, and deploy your static website with GitLab Pages. |
- [Roadmap](user/group/roadmap/index.md) **[ULTIMATE]** | [Groups](user/group/index.md) and [Subgroups](user/group/subgroups/index.md) | Organize your projects in groups. |
- [Contribution Analytics](user/group/contribution_analytics/index.md): See detailed statistics of group contributors. **[STARTER]** | [Issues Analytics](user/group/issues_analytics/index.md) **[PREMIUM]** | Check how many issues were created per month. |
- [Issues Analytics](user/group/issues_analytics/index.md): Check how many issues were created per month. **[PREMIUM]** | [Projects](user/project/index.md), including [project access](public_access/public_access.md) and [settings](user/project/settings/index.md) | Host source code, and control your project's visibility and set configuration. |
- [Search through GitLab](user/search/index.md): Search for issues, merge requests, projects, groups, todos, and issues in Issue Boards. | [Search through GitLab](user/search/index.md) | Search for issues, merge requests, projects, groups, and todos. |
- [Advanced Global Search](user/search/advanced_global_search.md): Leverage Elasticsearch for faster, more advanced code search across your entire GitLab instance. **[STARTER]** | [Snippets](user/snippets.md) | Snippets allow you to create little bits of code. |
- [Advanced Syntax Search](user/search/advanced_search_syntax.md): Use advanced queries for more targeted search results. **[STARTER]** | [Web IDE](user/project/web_ide/index.md) | Edit files within GitLab's user interface. |
- [Snippets](user/snippets.md): Snippets allow you to create little bits of code. | [Wikis](user/project/wiki/index.md) | Enhance your repository documentation with built-in wikis. |
- [Wikis](user/project/wiki/index.md): Enhance your repository documentation with built-in wikis.
- [Web IDE](user/project/web_ide/index.md) <div align="right">
<a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
---
#### Repositories #### Repositories
Manage your [repositories](user/project/repository/index.md) from the UI (user interface): | Create Topics - Repositories | Description |
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------|
- [Files](user/project/repository/index.md#files) | [Branches](user/project/repository/branches/index.md) and the [default branch](user/project/repository/branches/index.md#default-branch) | How to use branches in GitLab. |
- [Create a file](user/project/repository/web_editor.md#create-a-file) | [Commits](user/project/repository/index.md#commits) and [signing commits](user/project/repository/gpg_signed_commits/index.md) | Work with commits, and use GPG to sign your commits. |
- [Upload a file](user/project/repository/web_editor.md#upload-a-file) | [Create branches](user/project/repository/web_editor.md#create-a-new-branch), [create](user/project/repository/web_editor.md#create-a-file) and [upload](user/project/repository/web_editor.md#upload-a-file) files, and [create directories](user/project/repository/web_editor.md#create-a-directory) | Create branches, create and upload files, and create directories within GitLab. |
- [File templates](user/project/repository/web_editor.md#template-dropdowns) | [Delete merged branches](user/project/repository/branches/index.md#delete-merged-branches) | Bulk delete branches after their changes are merged. |
- [Jupyter Notebook files](user/project/repository/index.md#jupyter-notebook-files) | [File templates](user/project/repository/web_editor.md#template-dropdowns) | File templates for common files. |
- [Create a directory](user/project/repository/web_editor.md#create-a-directory) | [Files](user/project/repository/index.md#files) | Files management. |
- [Start a merge request](user/project/repository/web_editor.md#tips) (when committing via UI) | [Jupyter Notebook files](user/project/repository/index.md#jupyter-notebook-files) | GitLab's support for `.ipynb` files. |
- [File locking](user/project/file_lock.md): Lock a file to avoid merge conflicts. **[PREMIUM]** | [Protected branches](user/project/protected_branches.md) | Use protected branches. |
- [Branches](user/project/repository/branches/index.md) | [Push rules](push_rules/push_rules.md) **[STARTER]** | Additional control over pushes to your projects. |
- [Default branch](user/project/repository/branches/index.md#default-branch) | [Repositories](user/project/repository/index.md) | Manage source code repositories in GitLab's user interface. |
- [Create a branch](user/project/repository/web_editor.md#create-a-new-branch) | [Repository mirroring](workflow/repository_mirroring.md) **[STARTER]** | Push to or pull from repositories outside of GitLab |
- [Protected branches](user/project/protected_branches.md#protected-branches) | [Start a merge request](user/project/repository/web_editor.md#tips) | Start merge request when committing via GitLab's user interface. |
- [Delete merged branches](user/project/repository/branches/index.md#delete-merged-branches)
- [Commits](user/project/repository/index.md#commits) <div align="right">
- [Signing commits](user/project/repository/gpg_signed_commits/index.md): use GPG to sign your commits. <a type="button" class="btn btn-default" href="#overview">
- [Repository Mirroring](workflow/repository_mirroring.md) **[STARTER]** Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
- [Push rules](push_rules/push_rules.md): Additional control over pushes to your project. **[STARTER]** </a>
</div>
---
#### Merge Requests #### Merge Requests
- [Merge Requests](user/project/merge_requests/index.md) | Create Topics - Merge Requests | Description |
- [Work In Progress "WIP" Merge Requests](user/project/merge_requests/work_in_progress_merge_requests.md) |:------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------|
- [Merge Request discussion resolution](user/discussions/index.md#moving-a-single-discussion-to-a-new-issue): Resolve discussions, move discussions in a merge request to an issue, only allow merge requests to be merged if all discussions are resolved. | [Checking out merge requests locally](user/project/merge_requests/index.md#checkout-merge-requests-locally) | Tips for working with merge requests locally. |
- [Checkout merge requests locally](user/project/merge_requests/index.md#checkout-merge-requests-locally) | [Cherry-picking](user/project/merge_requests/cherry_pick_changes.md) | Use GitLab for cherry-picking changes. |
- [Cherry-pick](user/project/merge_requests/cherry_pick_changes.md) | [Merge request discussion resolution](user/discussions/index.md#moving-a-single-discussion-to-a-new-issue) | Resolve discussions, move discussions in a merge request to an issue, and only allow merge requests to be merged if all discussions are resolved. |
| [Merge requests](user/project/merge_requests/index.md) | Merge request management. |
| [Work In Progress "WIP" merge requests](user/project/merge_requests/work_in_progress_merge_requests.md) | Prevent merges of work-in-progress merge requests. |
<div align="right">
<a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
#### Integrations ---
- [Project Services](user/project/integrations/project_services.md): Integrate a project with external services, such as CI and chat. #### Integration and Automation
- [GitLab Integration](integration/README.md): Integrate with multiple third-party services with GitLab to allow external issue trackers and external authentication.
- [Trello Power-Up](integration/trello_power_up.md): Integrate with GitLab's Trello Power-Up.
- [JIRA Development Panel](integration/jira_development_panel.md): See GitLab information in the JIRA Development Panel. **[PREMIUM]**
#### Automation | Create Topics - Integration and Automation | Description |
|:------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------|
| [GitLab API](api/README.md) | Integrate GitLab via a simple and powerful API. |
| [GitLab Integration](integration/README.md) | Integrate with multiple third-party services with GitLab to allow external issue trackers and external authentication. |
| [GitLab Webhooks](user/project/integrations/webhooks.md) | Let GitLab notify you when new code has been pushed to your project. |
| [JIRA Development Panel](integration/jira_development_panel.md) **[PREMIUM]** | See GitLab information in the JIRA Development Panel. |
| [Project Services](user/project/integrations/project_services.md) | Integrate a project with external services, such as CI and chat. |
| [Trello Power-Up](integration/trello_power_up.md) | Integrate with GitLab's Trello Power-Up. |
- [API](api/README.md): Automate GitLab via a simple and powerful API. <div align="right">
- [GitLab Webhooks](user/project/integrations/webhooks.md): Let GitLab notify you when new code has been pushed to your project. <a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
### Verify ### Verify
Spot errors sooner, improve security and shorten feedback cycles with built-in Spot errors sooner, improve security and shorten feedback cycles with built-in
static code analysis, code testing, code quality, dependency checking and review static code analysis, code testing, code quality, dependency checking, and Review
apps. Customize your approval workflow controls, automatically test the quality Apps. Customize your approval workflow controls, automatically test the quality
of your code, and spin up a staging environment for every code change. GitLab of your code, and spin up a staging environment for every code change.
Continuous Integration is the most popular next generation testing system that
GitLab Continuous Integration is the most popular next generation testing system that
scales to run your tests faster. scales to run your tests faster.
- [GitLab CI/CD](ci/README.md): Explore the features and capabilities of Continuous Integration, Continuous Delivery, and Continuous Deployment with GitLab. The following documentation relates to the DevOps **Verify** stage:
- [Review Apps](ci/review_apps/index.md): Preview changes to your app right from a merge request.
- [Pipeline Graphs](ci/pipelines.md#pipeline-graphs) | Verify Topics | Description |
- [JUnit test reports](ci/junit_test_reports.md) |:----------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------|
- [Multi-project pipelines](ci/multi_project_pipelines.md) **[PREMIUM]** | [Code Quality reports](user/project/merge_requests/code_quality.md) **[STARTER]** | Analyze source code quality. |
- [Code Quality reports](user/project/merge_requests/code_quality.md) **[STARTER]** | [GitLab CI/CD](ci/README.md) | Explore the features and capabilities of Continuous Integration with GitLab. |
- [Static Application Security Testing (SAST) reports](user/project/merge_requests/sast.md) **[ULTIMATE]** | [JUnit test reports](ci/junit_test_reports.md) | Display JUnit test reports on merge requests. |
- [Dynamic Application Security Testing (DAST)](user/project/merge_requests/dast.md) **[ULTIMATE]** | [Multi-project pipelines](ci/multi_project_pipelines.md) **[PREMIUM]** | Visualize entire pipelines that span multiple projects, including all cross-project inter-dependencies. |
- [Dependency Scanning reports](user/project/merge_requests/dependency_scanning.md) **[ULTIMATE]** | [Pipeline Graphs](ci/pipelines.md#pipeline-graphs) | Visualize builds. |
- [Container Scanning reports](user/project/merge_requests/container_scanning.md) **[ULTIMATE]** | [Review Apps](ci/review_apps/index.md) | Preview changes to your application right from a merge request. |
<div align="right">
<a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
### Package ### Package
...@@ -163,7 +279,17 @@ GitLab Container Registry gives you the enhanced security and access controls of ...@@ -163,7 +279,17 @@ GitLab Container Registry gives you the enhanced security and access controls of
custom Docker images without 3rd party add-ons. Easily upload and download images custom Docker images without 3rd party add-ons. Easily upload and download images
from GitLab CI/CD with full Git repository management integration. from GitLab CI/CD with full Git repository management integration.
- [GitLab Container Registry](user/project/container_registry.md): Learn how to use GitLab's built-in Container Registry. The following documentation relates to the DevOps **Package** stage:
| Package Topics | Description |
|:----------------------------------------------------------------|:-------------------------------------------------------|
| [GitLab Container Registry](user/project/container_registry.md) | Learn how to use GitLab's built-in Container Registry. |
<div align="right">
<a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
### Release ### Release
...@@ -171,42 +297,74 @@ Spend less time configuring your tools, and more time creating. Whether you’re ...@@ -171,42 +297,74 @@ Spend less time configuring your tools, and more time creating. Whether you’re
deploying to one server or thousands, build, test, and release your code deploying to one server or thousands, build, test, and release your code
confidently and securely with GitLab’s built-in Continuous Delivery and Deployment. confidently and securely with GitLab’s built-in Continuous Delivery and Deployment.
- [Auto Deploy](topics/autodevops/index.md#auto-deploy): Configure GitLab CI for the deployment of your application. The following documentation relates to the DevOps **Release** stage:
- [Environments and deployments](ci/environments.md): With environments, you can control the continuous deployment of your software within GitLab.
- [GitLab Pages](user/project/pages/index.md): Build, test, and deploy a static site directly from GitLab. | Release Topics | Description |
- [Scheduled Pipelines](user/project/pipelines/schedules.md) |:----------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------|
- [Protected Runners](ci/runners/README.md#protected-runners) | [Auto Deploy](topics/autodevops/index.md#auto-deploy) | Configure GitLab for the deployment of your application. |
- [Deploy Boards](user/project/deploy_boards.md): View of the current health and status of each CI environment running on Kubernetes, displaying the status of the pods in the deployment. **[PREMIUM]** | [Canary Deployments](user/project/canary_deployments.md) **[PREMIUM]** | Employ a popular CI strategy where a small portion of the fleet is updated to the new version first. |
- [Canary Deployments](user/project/canary_deployments.md): A popular CI strategy, where a small portion of the fleet is updated to the new version first. **[PREMIUM]** | [Deploy Boards](user/project/deploy_boards.md) **[PREMIUM]** | View the current health and status of each CI environment running on Kubernetes, displaying the status of the pods in the deployment. |
| [Environments and deployments](ci/environments.md) | With environments, you can control the continuous deployment of your software within GitLab. |
| [Environment-specific variables](ci/variables/README.md#limiting-environment-scopes-of-variables) **[PREMIUM]** | Limit scope of variables to specific environments. |
| [GitLab CI/CD](ci/README.md) | Explore the features and capabilities of Continuous Deployment and Delivery with GitLab. |
| [GitLab Pages](user/project/pages/index.md) | Build, test, and deploy a static site directly from GitLab. |
| [Protected Runners](ci/runners/README.md#protected-runners) | Select Runners to only pick jobs for protected branches and tags. |
| [Scheduled Pipelines](user/project/pipelines/schedules.md) | Execute pipelines on a schedule. |
<div align="right">
<a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
### Configure ### Configure
Automate your entire workflow from build to deploy and monitoring with GitLab Automate your entire workflow from build to deploy and monitoring with GitLab
Auto Devops. Best practice templates get you started with minimal to zero Auto DevOps. Best practice templates get you started with minimal to zero
configuration. Then customize everything from buildpacks to CI/CD. configuration. Then customize everything from buildpacks to CI/CD.
- [Auto DevOps](topics/autodevops/index.md) The following documentation relates to the DevOps **Configure** stage:
- [Deployment of Helm, Ingress, and Prometheus on Kubernetes](user/project/clusters/index.md#installing-applications)
- [Protected variables](ci/variables/README.md#protected-variables) | Configure Topics | Description |
- [Easy creation of Kubernetes clusters on GKE](user/project/clusters/index.md#adding-and-creating-a-new-gke-cluster-via-gitlab) |:-------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------|
- [Multiple Kubernetes Clusters](user/project/clusters/index.md#multiple-kubernetes-clusters) **[PREMIUM]** | [Auto DevOps](topics/autodevops/index.md) | Automatically employ a complete DevOps lifecycle. |
- [Environment-specific variables](ci/variables/README.md#limiting-environment-scopes-of-variables) **[PREMIUM]** | [Easy creation of Kubernetes clusters on GKE](user/project/clusters/index.md#adding-and-creating-a-new-gke-cluster-via-gitlab) | Use Google Kubernetes Engine and GitLab. |
- [Executable Runbooks](user/project/clusters/runbooks/index.md) | [Executable Runbooks](user/project/clusters/runbooks/index.md) | Documented procedures that explain how to carry out particular processes. |
| [GitLab ChatOps](ci/chatops/README.md) **[ULTIMATE]** | Interact with CI/CD jobs through chat services. |
| [Installing Applications](user/project/clusters/index.md#installing-applications) | Deploy Helm, Ingress, and Prometheus on Kubernetes. |
| [Mattermost slash commands](user/project/integrations/mattermost_slash_commands.md) | Enable and use slash commands from within Mattermost. |
| [Multiple Kubernetes Clusters](user/project/clusters/index.md#multiple-kubernetes-clusters) **[PREMIUM]** | Associate more than one Kubernetes clusters to your project. |
| [Protected variables](ci/variables/README.md#protected-variables) | Restrict variables to protected branches and tags. |
| [Slack slash commands](user/project/integrations/slack_slash_commands.md) | Enable and use slash commands from within Slack. |
<div align="right">
<a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
### Monitor ### Monitor
Measure how long it takes to go from planning to monitoring and ensure your Ensure your applications are always responsive and available.
applications are always responsive and available. GitLab collects and displays
performance metrics for deployed apps using Prometheus so you can know in an GitLab collects and displays performance metrics for deployed applications so you can know in an
instant how code changes impact your production environment. instant how code changes impact your production environment.
- [GitLab Prometheus](administration/monitoring/prometheus/index.md): Configure the bundled Prometheus to collect various metrics from your GitLab instance. The following documentation relates to the DevOps **Monitor** stage:
- [Prometheus project integration](user/project/integrations/prometheus.md): Configure the Prometheus integration per project and monitor your CI/CD environments.
- [Prometheus metrics](user/project/integrations/prometheus_library/metrics.md): Let Prometheus collect metrics from various services, like Kubernetes, NGINX, NGINX ingress controller, HAProxy, and Amazon Cloud Watch. | Monitor Topics | Description |
- [GitLab Performance Monitoring](administration/monitoring/performance/index.md): Use InfluxDB and Grafana to monitor the performance of your GitLab instance (will be eventually replaced by Prometheus). |:--------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|
- [Health check](user/admin_area/monitoring/health_check.md): GitLab provides liveness and readiness probes to indicate service health and reachability to required services. | [GitLab Performance Monitoring](administration/monitoring/performance/index.md) | Use InfluxDB and Grafana to monitor the performance of your GitLab instance (will be eventually replaced by Prometheus). |
- [GitLab Cycle Analytics](user/project/cycle_analytics.md): Cycle Analytics measures the time it takes to go from an | [GitLab Prometheus](administration/monitoring/prometheus/index.md) | Configure the bundled Prometheus to collect various metrics from your GitLab instance. |
[idea to production](https://about.gitlab.com/2016/08/05/continuous-integration-delivery-and-deployment-with-gitlab/#from-idea-to-production-with-gitlab) for each project you have. | [Health check](user/admin_area/monitoring/health_check.md) | GitLab provides liveness and readiness probes to indicate service health and reachability to required services. |
| [Prometheus project integration](user/project/integrations/prometheus.md) | Configure the Prometheus integration per project and monitor your CI/CD environments. |
| [Prometheus metrics](user/project/integrations/prometheus_library/metrics.md) | Let Prometheus collect metrics from various services, like Kubernetes, NGINX, NGINX ingress controller, HAProxy, and Amazon Cloud Watch. |
<div align="right">
<a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
### Secure ### Secure
...@@ -214,89 +372,188 @@ Check your application for security vulnerabilities that may lead to unauthorize ...@@ -214,89 +372,188 @@ Check your application for security vulnerabilities that may lead to unauthorize
data leaks, and denial of services. GitLab will perform static and dynamic tests on the data leaks, and denial of services. GitLab will perform static and dynamic tests on the
code of your application, looking for known flaws and report them in the merge request code of your application, looking for known flaws and report them in the merge request
so you can fix them before merging. Security teams can use dashboards to get a so you can fix them before merging. Security teams can use dashboards to get a
high-level view on projects and groups, and start remediation processes when needed: high-level view on projects and groups, and start remediation processes when needed.
- [Static Application Security Testing (SAST)](user/project/merge_requests/sast.md) The following documentation relates to the DevOps **Secure** stage:
- [Dynamic Application Security Testing (DAST)](user/project/merge_requests/dast.md)
- [Dependency Scanning](user/project/merge_requests/dependency_scanning.md)
- [Container Scanning](user/project/merge_requests/container_scanning.md)
- [License Management](user/project/merge_requests/license_management.md)
- [Group Security Dashboard](user/group/security_dashboard/index.md)
- [Project Security Dashboard](user/project/security_dashboard.md)
## Getting started with GitLab | Monitor Topics | Description |
|:--------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|
| [Container Scanning](user/project/merge_requests/container_scanning.md) **[ULTIMATE]** | Use Clair to scan docker images for known vulnerabilities. |
| [Dependency Scanning](user/project/merge_requests/dependency_scanning.md) **[ULTIMATE]** | Analyze your dependencies for known vulnerabilities. |
| [Dynamic Application Security Testing (DAST)](user/project/merge_requests/dast.md) **[ULTIMATE]** | Analyze running web applications for known vulnerabilities. |
| [Group Security Dashboard](user/group/security_dashboard/index.md) **[ULTIMATE]** | View vulnerabilities in all the projects in a group and its subgroups. |
| [License Management](user/project/merge_requests/license_management.md) **[ULTIMATE]** | Search your project's dependencies for their licenses. |
| [Project Security Dashboard](user/project/security_dashboard.md) **[ULTIMATE]** | View the latest security reports for your project. |
| [Static Application Security Testing (SAST)](user/project/merge_requests/sast.md) **[ULTIMATE]** | Analyze source code for known vulnerabilities. |
- [GitLab Basics](gitlab-basics/README.md): Start working on your command line and on GitLab. ## Subscribe to GitLab
- [GitLab Workflow](workflow/README.md): Enhance your workflow with the best of GitLab Workflow.
- See also [GitLab Workflow - an overview](https://about.gitlab.com/2016/10/25/gitlab-workflow-an-overview/).
- [GitLab Markdown](user/markdown.md): GitLab's advanced formatting system (GitLab Flavored Markdown).
### User account There are two ways to use GitLab:
- [User account](user/profile/index.md): Manage your account - [GitLab self-managed](#gitlab-self-managed): Install, administer, and maintain your own GitLab instance.
- [Authentication](topics/authentication/index.md): Account security with two-factor authentication, set up your ssh keys and deploy keys for secure access to your projects. - [GitLab.com](#gitlab-com): GitLab's SaaS offering. You don't need to install anything to use GitLab.com,
- [Profile settings](user/profile/index.md#profile-settings): Manage your profile settings, two factor authentication and more. you only need to [sign up](https://gitlab.com/users/sign_in) and start using GitLab straight away.
- [User permissions](user/permissions.md): Learn what each role in a project (external/guest/reporter/developer/maintainer/owner) can do.
### Git and GitLab The following sections outline tiers and features within GitLab self-managed and GitLab.com.
- [Git](topics/git/index.md): Getting started with Git, branching strategies, Git LFS, advanced use. <div align="right">
- [Git cheatsheet](https://about.gitlab.com/images/press/git-cheat-sheet.pdf): Download a PDF describing the most used Git operations. <a type="button" class="btn btn-default" href="#overview">
- [GitLab Flow](workflow/gitlab_flow.md): explore the best of Git with the GitLab Flow strategy. Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## Administrator documentation ### GitLab self-managed
[Administration documentation](administration/index.md) applies to admin users of GitLab With GitLab self-managed, you deploy your own GitLab instance on-premises or on a private cloud of your choice.
self-hosted instances. GitLab self-managed is available for [free and with paid subscriptions](https://about.gitlab.com/pricing/#self-managed) in the following tiers:
Learn how to install, configure, update, upgrade, integrate, and maintain your own instance. | Tier | Includes |
Regular users don't have access to GitLab administration tools and settings. |:---------|:-----------------------------------------------|
| Core | Core features. |
| Starter | Core and Starter features. |
| Premium | Core, Starter, and Premium features. |
| Ultimate | Core, Starter, Premium, and Ultimate features. |
## Contributor documentation To learn more about GitLab:
GitLab Community Edition is [open source](https://gitlab.com/gitlab-org/gitlab-ce/) - Features at each tier, see our [Feature Comparison](https://about.gitlab.com/pricing/self-managed/feature-comparison/) for self-managed.
and GitLab Enterprise Edition is [open-core](https://gitlab.com/gitlab-org/gitlab-ee/). - Subscriptions and licensing, please refer to the [GitLab Product Marketing Handbook](https://about.gitlab.com/handbook/marketing/product-marketing/#tiers).
Learn how to contribute to GitLab:
- [Development](development/README.md): All styleguides and explanations how to contribute. <div align="right">
- [Legal](legal/README.md): Contributor license agreements. <a type="button" class="btn btn-default" href="#overview">
- [Writing documentation](development/documentation/index.md): Contributing to GitLab Docs. Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## GitLab subscriptions ### GitLab.com
You have two options to use GitLab: GitLab.com is hosted, managed, and administered by GitLab, Inc., with
[free and paid subscriptions](https://about.gitlab.com/pricing/) for individuals
and teams in the following tiers:
| Tier | Includes same features available in |
|:-------|:----------------------------------------------------|
| Free | [Core](#gitlab-self-managed) self-managed tier. |
| Bronze | [Starter](#gitlab-self-managed) self-managed tier. |
| Silver | [Premium](#gitlab-self-managed) self-managed tier. |
| Gold | [Ultimate](#gitlab-self-managed) self-managed tier. |
GitLab.com subscriptions grant access
to the same features available in GitLab self-managed, **except
[administration](administration/index.md) tools and settings**:
- GitLab self-hosted: Install, administer, and maintain your own GitLab instance. TIP: **Tip:**
- GitLab.com: GitLab's SaaS offering. You don't need to install anything to use GitLab.com, To support the open source community and encourage the development of open source projects, GitLab grants access to **Gold** features for all GitLab.com **public** projects, regardless of the subscription.
you only need to [sign up](https://gitlab.com/users/sign_in) and start using GitLab
straight away.
### GitLab self-hosted To learn more about GitLab:
With GitLab self-hosted, you deploy your own GitLab instance on-premises or on a private cloud of your choice. GitLab self-hosted is available for [free and with paid subscriptions](https://about.gitlab.com/pricing/): Core, Starter, Premium, and Ultimate. - Features at each tier, see our [Feature Comparison](https://about.gitlab.com/pricing/gitlab-com/feature-comparison/) for GitLab.com.
- Subscriptions and licensing, please refer to the [GitLab Product Marketing Handbook](https://about.gitlab.com/handbook/marketing/product-marketing/#tiers).
Every feature available in Core is also available in Starter, Premium, and Ultimate. <div align="right">
Starter features are also available in Premium and Ultimate, and Premium features are also <a type="button" class="btn btn-default" href="#overview">
available in Ultimate. Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
### GitLab.com ## New to Git and GitLab?
GitLab.com is hosted, managed, and administered by GitLab, Inc., with Working with new systems can be daunting.
[free and paid subscriptions](https://about.gitlab.com/gitlab-com/) for individuals
and teams: Free, Bronze, Silver, and Gold.
GitLab.com subscriptions grants access We have the following documentation to rapidly uplift your GitLab knowledge:
to the same features available in GitLab self-hosted, **except
[administration](administration/index.md) tools and settings**: | Topic | Description |
|:-----------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------|
| [GitLab Basics](gitlab-basics/README.md) | Start working on the command line and with GitLab. |
| [GitLab Workflow](workflow/README.md) and [overview](https://about.gitlab.com/2016/10/25/gitlab-workflow-an-overview/) | Enhance your workflow with the best of GitLab Workflow. |
| [Get started with GitLab CI/CD](ci/quick_start/README.md) | Quickly implement GitLab CI/CD. |
| [Auto DevOps](topics/autodevops/index.md) | Learn more about GitLab's Auto DevOps. |
| [GitLab Markdown](user/markdown.md) | GitLab's advanced formatting system (GitLab Flavored Markdown) |
<div align="right">
<a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
### User account
Learn more about GitLab account management:
| Topic | Description |
|:-----------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------|
| [User account](user/profile/index.md) | Manage your account. |
| [Authentication](topics/authentication/index.md) | Account security with two-factor authentication, set up your ssh keys, and deploy keys for secure access to your projects. |
| [Profile settings](user/profile/index.md#profile-settings) | Manage your profile settings, two factor authentication, and more. |
| [User permissions](user/permissions.md) | Learn what each role in a project can do. |
<div align="right">
<a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
### Git and GitLab
Learn more about using Git, and using Git with GitLab:
| Topic | Description |
|:----------------------------------------------------------------------------|:---------------------------------------------------------------------------|
| [Git](topics/git/index.md) | Getting started with Git, branching strategies, Git LFS, and advanced use. |
| [Git cheatsheet](https://about.gitlab.com/images/press/git-cheat-sheet.pdf) | Download a PDF describing the most used Git operations. |
| [GitLab Flow](workflow/gitlab_flow.md) | Explore the best of Git with the GitLab Flow strategy. |
<div align="right">
<a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## Coming to GitLab from another platform
If you are coming to GitLab from another platform, you'll find the following information useful:
| Topic | Description |
|:---------------------------------------------------------------|:---------------------------------------------------------------------------------------|
| [Importing to GitLab](user/project/import/index.md) | Import your projects from GitHub, Bitbucket, GitLab.com, FogBugz, and SVN into GitLab. |
| [Migrating from SVN](workflow/importing/migrating_from_svn.md) | Convert a SVN repository to Git and GitLab. |
<div align="right">
<a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## Building an integration with GitLab
There are many ways to integrate with GitLab, including:
| Topic | Description |
|:-----------------------------------------------------------|:------------------------------------------------|
| [GitLab API](api/README.md) | Integrate GitLab via a simple and powerful API. |
| [Integrations and automation](#integration-and-automation) | All GitLab integration and automation options. |
<div align="right">
<a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## Contributing to GitLab
GitLab Community Edition is [open source](https://gitlab.com/gitlab-org/gitlab-ce/)
and GitLab Enterprise Edition is [open-core](https://gitlab.com/gitlab-org/gitlab-ee/).
- GitLab.com Free includes the same features available in Core Learn how to contribute to GitLab with the following resources:
- GitLab.com Bronze includes the same features available in GitLab Starter
- GitLab.com Silver includes the same features available in GitLab Premium
- GitLab.com Gold includes the same features available in GitLab Ultimate
For supporting the open source community and encouraging the development of | Topic | Description |
open source projects, GitLab grants access to **Gold** features |:------------------------------------------------------------|:-----------------------------------------|
for all GitLab.com **public** projects, regardless of the subscription. | [Development](development/README.md) | How to contribute to GitLab development. |
| [Legal](legal/README.md) | Contributor license agreements. |
| [Writing documentation](development/documentation/index.md) | How to contribute to GitLab Docs. |
To know more about GitLab subscriptions and licensing, please refer to the <div align="right">
[GitLab Product Marketing Handbook](https://about.gitlab.com/handbook/marketing/product-marketing/#tiers). <a type="button" class="btn btn-default" href="#overview">
Back to Overview <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7