Commit 74a8d300 authored by Marcel Amirault's avatar Marcel Amirault Committed by Evan Read

Fix whitespace in user, and misc, docs

Many code blocks are 4spaced, and they render in GitLab
without coloring as a result, even though they are
fenced with a language label. If in a list, other items
woll render as being in a code block too, even if not
meant to. This fixes all these issues, and cleans up
minor whitespace issues in /user, /security, /ssh
and /migrate_ci_to_ce docs.
parent 5f8a6730
...@@ -181,7 +181,7 @@ sudo -u gitlab_ci -H bundle exec rake backup:show_secrets RAILS_ENV=production ...@@ -181,7 +181,7 @@ sudo -u gitlab_ci -H bundle exec rake backup:show_secrets RAILS_ENV=production
### 2. SQL data and build traces ### 2. SQL data and build traces
Create your final CI data export. If you are converting from MySQL to Create your final CI data export. If you are converting from MySQL to
PostgreSQL, add ` MYSQL_TO_POSTGRESQL=1` to the end of the rake command. When PostgreSQL, add `MYSQL_TO_POSTGRESQL=1` to the end of the rake command. When
the command finishes it will print the path to your data export archive; you the command finishes it will print the path to your data export archive; you
will need this file later. will need this file later.
...@@ -323,11 +323,15 @@ You should also make sure that you can: ...@@ -323,11 +323,15 @@ You should also make sure that you can:
### 2. Check Nginx configuration ### 2. Check Nginx configuration
sudo nginx -t ```sh
sudo nginx -t
```
### 3. Restart Nginx ### 3. Restart Nginx
sudo /etc/init.d/nginx restart ```sh
sudo /etc/init.d/nginx restart
```
### Restore from backup ### Restore from backup
...@@ -352,11 +356,13 @@ The fix for this is to update to Omnibus 7.14 first and then update it to 8.0. ...@@ -352,11 +356,13 @@ The fix for this is to update to Omnibus 7.14 first and then update it to 8.0.
### Permission denied when accessing /var/opt/gitlab/gitlab-ci/builds ### Permission denied when accessing /var/opt/gitlab/gitlab-ci/builds
To fix that issue you have to change builds/ folder permission before doing final backup: To fix that issue you have to change builds/ folder permission before doing final backup:
``` ```
sudo chown -R gitlab-ci:gitlab-ci /var/opt/gitlab/gitlab-ci/builds sudo chown -R gitlab-ci:gitlab-ci /var/opt/gitlab/gitlab-ci/builds
``` ```
Then before executing `ci:migrate` you need to fix builds folder permission: Then before executing `ci:migrate` you need to fix builds folder permission:
``` ```
sudo chown git:git /var/opt/gitlab/gitlab-ci/builds sudo chown git:git /var/opt/gitlab/gitlab-ci/builds
``` ```
......
...@@ -176,7 +176,6 @@ Now, it's time to add the newly created public key to your GitLab account. ...@@ -176,7 +176,6 @@ Now, it's time to add the newly created public key to your GitLab account.
1. Add your **public** SSH key to your GitLab account by: 1. Add your **public** SSH key to your GitLab account by:
1. Clicking your avatar in the upper right corner and selecting **Settings**. 1. Clicking your avatar in the upper right corner and selecting **Settings**.
1. Navigating to **SSH Keys** and pasting your **public** key in the **Key** field. If you: 1. Navigating to **SSH Keys** and pasting your **public** key in the **Key** field. If you:
- Created the key with a comment, this will appear in the **Title** field. - Created the key with a comment, this will appear in the **Title** field.
- Created the key without a comment, give your key an identifiable title like _Work Laptop_ or _Home Workstation_. - Created the key without a comment, give your key an identifiable title like _Work Laptop_ or _Home Workstation_.
1. Click the **Add key** button. 1. Click the **Add key** button.
......
...@@ -586,9 +586,11 @@ def function(): ...@@ -586,9 +586,11 @@ def function():
print s print s
``` ```
Using 4 spaces ```
is like using Using 4 spaces
3-backtick fences. is like using
3-backtick fences.
```
~~~ ~~~
Tildes are OK too. Tildes are OK too.
......
...@@ -115,6 +115,7 @@ To add an existing Kubernetes cluster to your project: ...@@ -115,6 +115,7 @@ To add an existing Kubernetes cluster to your project:
```sh ```sh
kubectl cluster-info | grep 'Kubernetes master' | awk '/http/ {print $NF}' kubectl cluster-info | grep 'Kubernetes master' | awk '/http/ {print $NF}'
``` ```
- **CA certificate** (required) - A valid Kubernetes certificate is needed to authenticate to the EKS cluster. We will use the certificate created by default. - **CA certificate** (required) - A valid Kubernetes certificate is needed to authenticate to the EKS cluster. We will use the certificate created by default.
- List the secrets with `kubectl get secrets`, and one should named similar to - List the secrets with `kubectl get secrets`, and one should named similar to
`default-token-xxxxx`. Copy that token name for use below. `default-token-xxxxx`. Copy that token name for use below.
...@@ -123,6 +124,7 @@ To add an existing Kubernetes cluster to your project: ...@@ -123,6 +124,7 @@ To add an existing Kubernetes cluster to your project:
```sh ```sh
kubectl get secret <secret name> -o jsonpath="{['data']['ca\.crt']}" | base64 --decode kubectl get secret <secret name> -o jsonpath="{['data']['ca\.crt']}" | base64 --decode
``` ```
- **Token** - - **Token** -
GitLab authenticates against Kubernetes using service tokens, which are GitLab authenticates against Kubernetes using service tokens, which are
scoped to a particular `namespace`. scoped to a particular `namespace`.
......
...@@ -202,7 +202,7 @@ Follow these steps to deploy a function using the Node.js runtime to your Knativ ...@@ -202,7 +202,7 @@ Follow these steps to deploy a function using the Node.js runtime to your Knativ
from **Apply a template** dropdown when editing the `.gitlab-ci.yml` file through from **Apply a template** dropdown when editing the `.gitlab-ci.yml` file through
the user interface. the user interface.
2. `serverless.yml`: this file contains the metadata for your functions, 1. `serverless.yml`: this file contains the metadata for your functions,
such as name, runtime, and environment. such as name, runtime, and environment.
It must be included at the root of your repository. It must be included at the root of your repository.
...@@ -288,7 +288,8 @@ The sample function can now be triggered from any HTTP client using a simple `PO ...@@ -288,7 +288,8 @@ The sample function can now be triggered from any HTTP client using a simple `PO
--data '{"GitLab":"FaaS"}' \ --data '{"GitLab":"FaaS"}' \
http://functions-echo.functions-1.functions.example.com/ http://functions-echo.functions-1.functions.example.com/
``` ```
2. Using a web-based tool (ie. postman, restlet, etc)
1. Using a web-based tool (ie. postman, restlet, etc)
![function execution](img/function-execution.png) ![function execution](img/function-execution.png)
...@@ -424,7 +425,6 @@ The instructions below relate to installing and running Certbot on a Linux serve ...@@ -424,7 +425,6 @@ The instructions below relate to installing and running Certbot on a Linux serve
1. Run the following command to use Certbot to request a certificate 1. Run the following command to use Certbot to request a certificate
using DNS challenge during authorization: using DNS challenge during authorization:
```sh ```sh
./certbot-auto certonly --manual --preferred-challenges dns -d '*.<namespace>.example.com' ./certbot-auto certonly --manual --preferred-challenges dns -d '*.<namespace>.example.com'
``` ```
......
...@@ -73,6 +73,7 @@ started: ...@@ -73,6 +73,7 @@ started:
What keysize do you want? (2048) 4096 What keysize do you want? (2048) 4096
Requested keysize is 4096 bits Requested keysize is 4096 bits
``` ```
1. Next, you need to specify the validity period of your key. This is something 1. Next, you need to specify the validity period of your key. This is something
subjective, and you can use the default value which is to never expire: subjective, and you can use the default value which is to never expire:
......
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