summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axil@gitlab.com>2017-09-20 19:52:23 +0200
committerAchilleas Pipinellis <axil@gitlab.com>2017-09-20 19:52:23 +0200
commit9b75283469a3377f00bbeb4aec1f106e7ced3872 (patch)
treef7f54b7db052097e6d98049b40ccf187bcc74833
parentbde69c3ef444fa236b1a1172e23c2af670fb901b (diff)
downloadgitlab-ce-9b75283469a3377f00bbeb4aec1f106e7ced3872.tar.gz
Simplify wording in Overview and base domain sections
-rw-r--r--doc/topics/autodevops/index.md33
1 files changed, 16 insertions, 17 deletions
diff --git a/doc/topics/autodevops/index.md b/doc/topics/autodevops/index.md
index 55252845167..98e46b43408 100644
--- a/doc/topics/autodevops/index.md
+++ b/doc/topics/autodevops/index.md
@@ -23,19 +23,18 @@ project in an easy and default way:
1. [Auto Deploy](#auto-deploy)
1. [Auto Monitoring](#-auto-monitoring)
-Auto DevOps combines a lot of different technologies into one product. It's
-good to have a basic knowledge of the following:
+As Auto DevOps relies on many different components, it's good to have a basic
+knowledge of the following:
-- Kubernetes
-- Helm
-- Docker
-- GitLab Runner
-- Prometheus
+- [Kubernetes](https://kubernetes.io/docs/home/)
+- [Helm](https://docs.helm.sh/)
+- [Docker](https://docs.docker.com)
+- [GitLab Runner](https://docs.gitlab.com/runner/)
+- [Prometheus](https://prometheus.io/docs/introduction/overview/)
TIP: **Tip:**
-At the beginning of the Auto DevOps setup, you are provided with some defaults
-for all the stages, you can, however, [customize](#customizing) almost everything
-to your needs.
+Auto DevOps provides some defaults for all the stages, you can, however,
+[customize](#customizing) almost everything to your needs.
## Prerequisites
@@ -106,19 +105,19 @@ The Auto DevOps base domain is required if you want to make use of [Auto
Review Apps](#auto-review-apps) and [Auto Deploy](#auto-deploy). It is defined
under the project's CI/CD settings while [enabling Auto DevOps](#enabling-auto-devops).
-A wildcard DNS A record is required:
+A wildcard DNS A record is required, for example:
```
*.example.com 3600 A 1.2.3.4
```
-where `example.com` your domain name and `1.2.3.4` the IP of your load balancer,
-generally NGINX ingress ([see prerequisites](#prerequisites)). How to set up the
-DNS record is beyond the scope of this document, you should check with your DNS
-provider.
+where `example.com` the domain name under which the deployed apps will be served,
+and `1.2.3.4` the IP of your load balancer, generally NGINX ingress
+([see prerequisites](#prerequisites)). How to set up the DNS record is beyond
+the scope of this document, you should check with your DNS provider.
-The way it works, is that all requests hit the load balances which in turn routes
-those requests to the Kubernetes pods that run your application(s).
+Once set up, all requests will hit the load balancer which in turn will route
+them to the Kubernetes pods that run your application(s).
NOTE: **Note:**
If GitLab is installed using the [GitLab Omnibus Helm Chart] there are two