summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2021-04-01 15:14:27 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2021-04-01 15:14:27 +0000
commitafbaf78b0d819326741a01b093bdbc4702570417 (patch)
treea16a6f2a8fcc18e60f25ac72df6ab22cfe0eae79 /doc
parent38b3003b67db3f2eadfa81fd28b13d168f665766 (diff)
downloadgitlab-ce-afbaf78b0d819326741a01b093bdbc4702570417.tar.gz
Add latest changes from gitlab-org/gitlab@13-10-stable-ee
Diffstat (limited to 'doc')
-rw-r--r--doc/user/application_security/sast/index.md3
-rw-r--r--doc/user/clusters/agent/index.md46
-rw-r--r--doc/user/group/epics/epic_boards.md68
-rw-r--r--doc/user/group/epics/img/epic_board_v13_10.pngbin0 -> 147584 bytes
4 files changed, 104 insertions, 13 deletions
diff --git a/doc/user/application_security/sast/index.md b/doc/user/application_security/sast/index.md
index b71cefbc7fe..fffff4efba6 100644
--- a/doc/user/application_security/sast/index.md
+++ b/doc/user/application_security/sast/index.md
@@ -100,8 +100,7 @@ and the [Maven wrapper](https://github.com/takari/maven-wrapper).
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4895) in GitLab 13.7.
-GitLab SAST can scan repositories that contain multiple projects. All projects must be in the same
-language.
+GitLab SAST can scan repositories that contain multiple projects.
The following analyzers have multi-project support:
diff --git a/doc/user/clusters/agent/index.md b/doc/user/clusters/agent/index.md
index 9af339b20c6..77b9dbb1c7e 100644
--- a/doc/user/clusters/agent/index.md
+++ b/doc/user/clusters/agent/index.md
@@ -7,7 +7,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# GitLab Kubernetes Agent **(PREMIUM SELF)**
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/223061) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.4.
-> - It's disabled on GitLab.com. Rolling this feature out to GitLab.com is [planned](https://gitlab.com/groups/gitlab-org/-/epics/3834).
+> - [In GitLab 13.10](https://gitlab.com/gitlab-org/gitlab/-/issues/300960), KAS became available on GitLab.com under `wss://kas.gitlab.com` through an Early Adopter Program.
WARNING:
This feature might not be available to you. Check the **version history** note above for details.
@@ -85,7 +85,7 @@ component, `agentk`.
Upgrade your agent installations together with GitLab upgrades. To decide which version of `agentk`to install follow:
-1. Open the [GITLAB_KAS_VERSION](https://gitlab.com/gitlab-org/gitlab/-/blob/master/GITLAB_KAS_VERSION) file from the GitLab Repository, which contains the latest `agentk` version associated with the `master` branch.
+1. Open the [`GITLAB_KAS_VERSION`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/GITLAB_KAS_VERSION) file from the GitLab Repository, which contains the latest `agentk` version associated with the `master` branch.
1. Change the `master` branch and select the Git tag associated with your version. For instance, you could change it to GitLab [v13.5.3-ee release](https://gitlab.com/gitlab-org/gitlab/-/blob/v13.5.3-ee/GITLAB_KAS_VERSION)
The available `agentk` and `kas` versions can be found in
@@ -96,20 +96,21 @@ The available `agentk` and `kas` versions can be found in
[Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3834) in GitLab 13.10,
the GitLab Kubernetes Agent Server (KAS) is available on GitLab.com under `wss://kas.gitlab.com`.
If you are a GitLab.com user, skip this step and directly
-[set up the configuration repository](#define-a-configuration-repository)
+[set up the configuration repository](#define-a-configuration-repository)
for your agent.
-The GitLab Kubernetes Agent Server (KAS) can be deployed using [Omnibus
-GitLab](https://docs.gitlab.com/omnibus/) or the [GitLab
-chart](https://gitlab.com/gitlab-org/charts/gitlab). If you don't already have
+The GitLab Kubernetes Agent Server (KAS) can be installed through Omnibus GitLab or
+through the GitLab Helm Chart. If you don't already have
GitLab installed, please refer to our [installation
documentation](https://docs.gitlab.com/ee/install/README.html).
+You can install the KAS within GitLab as explained below according to your GitLab installation method.
+You can also opt to use an [external KAS](#use-an-external-kas-installation).
-#### Install with Omnibus
+#### Install KAS with Omnibus
-When using the [Omnibus GitLab](https://docs.gitlab.com/omnibus/) package:
+For [Omnibus](https://docs.gitlab.com/omnibus/) package installations:
-1. Edit `/etc/gitlab/gitlab.rb`:
+1. Edit `/etc/gitlab/gitlab.rb` to enable the Kubernetes Agent Server:
```plaintext
gitlab_kas['enable'] = true
@@ -121,9 +122,9 @@ To configure any additional options related to GitLab Kubernetes Agent Server,
refer to the **Enable GitLab KAS** section of the
[`gitlab.rb.template`](https://gitlab.com/gitlab-org/omnibus-gitlab/-/blob/master/files/gitlab-config-template/gitlab.rb.template).
-#### Install with the Helm chart
+#### Install KAS with GitLab Helm Chart
-When installing or upgrading the GitLab Helm chart, consider the following Helm v3 example.
+For GitLab [Helm Chart](https://gitlab.com/gitlab-org/charts/gitlab) installations, consider the following Helm v3 example.
If you're using Helm v2, you must modify this example. See our [notes regarding deploy with Helm](https://docs.gitlab.com/charts/installation/deployment.html#deploy-using-helm).
You must set `global.kas.enabled=true` for the KAS to be properly installed and configured:
@@ -150,6 +151,29 @@ gitlab:
For details, read [Using the GitLab-KAS chart](https://docs.gitlab.com/charts/charts/gitlab/kas/).
+#### Use an external KAS installation
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299850) in GitLab 13.10.
+
+Besides installing KAS with GitLab, you can opt to configure GitLab to use an external KAS.
+
+For GitLab instances installed through the GitLab Helm Chart, see [how to configure your external KAS](https://docs.gitlab.com/charts/charts/globals.html#external-kas).
+
+For GitLab instances installed through Omnibus packages:
+
+1. Edit `/etc/gitlab/gitlab.rb` adding the paths to your external KAS:
+
+ ```ruby
+ gitlab_kas['enable'] = false
+ gitlab_kas['api_secret_key'] = 'Your shared secret between GitLab and KAS'
+
+ gitlab_rails['gitlab_kas_enabled'] = true
+ gitlab_rails['gitlab_kas_external_url'] = 'wss://kas.gitlab.example.com' # User-facing URL for the in-cluster agentk
+ gitlab_rails['gitlab_kas_internal_url'] = 'grpc://kas.internal.gitlab.example.com' # Internal URL for the GitLab backend
+ ```
+
+1. [Reconfigure GitLab](../../../administration/restart_gitlab.md#omnibus-gitlab-reconfigure).
+
### Define a configuration repository
Next, you need a GitLab repository to contain your Agent configuration. The minimal
diff --git a/doc/user/group/epics/epic_boards.md b/doc/user/group/epics/epic_boards.md
new file mode 100644
index 00000000000..343f7c496b1
--- /dev/null
+++ b/doc/user/group/epics/epic_boards.md
@@ -0,0 +1,68 @@
+---
+stage: Plan
+group: Product Planning
+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
+---
+
+# Epic Boards **(PREMIUM)**
+
+> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2864) in GitLab 13.10.
+> - It's [deployed behind a feature flag](../../feature_flags.md), disabled by default.
+> - It's disabled on GitLab.com.
+> - It's not recommended for production use.
+> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](../../../administration/feature_flags.md).
+
+WARNING:
+This feature might not be available to you. Check the **version history** note above for details.
+
+The GitLab Epic Board is a software project management tool used to plan,
+organize, and visualize a workflow for a feature or product release.
+
+Epic boards build on the existing [epic tracking functionality](index.md) and
+[labels](../../project/labels.md). Your epics appear as cards in vertical lists, organized by their assigned
+labels.
+
+To view an epic board, in a group, select **Epics > Boards**.
+
+![GitLab epic board - Premium](img/epic_board_v13_10.png)
+
+## Create an epic board
+
+To create a new epic board:
+
+1. Select the dropdown with the current board name in the upper left corner of the Epic Boards page.
+1. Select **Create new board**.
+1. Enter the new board's name and select **Create**.
+
+## Limitations of epic boards
+
+As of GitLab 13.10, these limitations apply:
+
+- Epic Boards need to be enabled by an administrator.
+- Epic Boards can be created but not deleted.
+- Lists can be added to the board but not deleted.
+- There is no sidebar on the board. To edit an epic, go to the epic's page.
+- There is no drag and drop support yet. To move an epic between lists, edit epic labels on the epic's page.
+- Epics cannot be re-ordered within the list.
+
+To learn more about the future iterations of this feature, visit
+[epic 5067](https://gitlab.com/groups/gitlab-org/-/epics/5067).
+
+## Enable or disable Epic Boards
+
+Epic Boards are under development and not ready for production use. It is
+deployed behind a feature flag that is **disabled by default**.
+[GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md)
+can enable it.
+
+To enable it:
+
+```ruby
+Feature.enable(:epic_boards)
+```
+
+To disable it:
+
+```ruby
+Feature.disable(:epic_boards)
+```
diff --git a/doc/user/group/epics/img/epic_board_v13_10.png b/doc/user/group/epics/img/epic_board_v13_10.png
new file mode 100644
index 00000000000..5148e6dd4ec
--- /dev/null
+++ b/doc/user/group/epics/img/epic_board_v13_10.png
Binary files differ