Commit 021a95c6 authored by Amy Qualls's avatar Amy Qualls

Revise new section for tone and style

This section needed some cleanup to be ready to go. Tidy it a bit
to get it closer to GitLab tone and style.
parent c3e300ba
......@@ -134,34 +134,41 @@ This is a brief overview. Please refer to the above instructions for more contex
## Use `gitlab-sshd` instead of OpenSSH
WARNING:
`gitlab-sshd` is in **Alpha**. It is not ready for production use.
NOTE:
`gitlab-sshd` component is only available for [Cloud Native Helm Charts](https://docs.gitlab.com/charts/) deployments.
NOTE:
`gitlab-sshd` supports PROXY protocol it can run behind proxy servers that rely on it (for example, HAProxy).
NOTE:
`gitlab-sshd` does not share a SSH port with the system administrator's OpenSSH and requires a bind to port 22.
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299109) in GitLab 14.5.
NOTE:
`gitlab-sshd` **does not** support SSH certificates.
`gitlab-sshd` is [a standalone SSH server written in Go](https://gitlab.com/gitlab-org/gitlab-shell/-/tree/main/internal/sshd). It is provided as a part of `gitlab-shell` package.
It has a lower memory use as a OpenSSH alternative and supports [group access restriction by IP address](../../user/group/index.md) for applications running behind the proxy.
Set `gitlab-shell` charts `sshDaemon` option to [`gitlab-sshd`](https://docs.gitlab.com/charts/charts/gitlab/gitlab-shell/index.html#installation-command-line-options) and perform a Helm upgrade.
Below is an example use of `sshDaemon`:
WARNING:
`gitlab-sshd` is in [**Alpha**](https://about.gitlab.com/handbook/product/gitlab-the-product/#alpha-beta-ga).
It is not ready for production use.
`gitlab-sshd` is [a standalone SSH server](https://gitlab.com/gitlab-org/gitlab-shell/-/tree/main/internal/sshd)
written in Go. It is provided as a part of `gitlab-shell` package. It has a lower memory
use as a OpenSSH alternative and supports
[group access restriction by IP address](../../user/group/index.md) for applications
running behind the proxy.
If you are considering switching from OpenSSH to `gitlab-sshd`, consider these concerns:
- The `gitlab-sshd` component is only available for
[Cloud Native Helm Charts](https://docs.gitlab.com/charts/) deployments.
- `gitlab-sshd` supports the PROXY protocol. It can run behind proxy servers that rely
on it, such as HAProxy.
- `gitlab-sshd` does not share a SSH port with the system administrator's OpenSSH,
and requires a bind to port 22.
- `gitlab-sshd` **does not** support SSH certificates.
To switch from OpenSSH to `gitlab-sshd`:
1. Set the `gitlab-shell` charts `sshDaemon` option to
[`gitlab-sshd`](https://docs.gitlab.com/charts/charts/gitlab/gitlab-shell/index.html#installation-command-line-options).
For example:
```yaml
gitlab:
gitlab-shell:
sshDaemon: gitlab-sshd
```
```yaml
gitlab:
gitlab-shell:
sshDaemon: gitlab-sshd
```
1. Perform a Helm upgrade.
## Compiling a custom version of OpenSSH for CentOS 6
......
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