Commit 7492ae24 authored by Ludvig Bohlin's avatar Ludvig Bohlin

Fixed some broken links

parent 3ea11c55
Pipeline #9950 passed with stage
in 56 seconds
......@@ -4,9 +4,10 @@
We put at your disposal three configuration options for `haproxy-devlove-views`, and a fourth one that is similar to the second and you can use it directly to modify it and choose a new one. You can appreciate the configuration obtained by choosing the `option-<i>` in `roles/create_deploys/templates/config/option-<i>/example-results`.
### Configurations
| <div style="width:250px">Option</div> | Description |
| Option | Description |
|----------|:-------------|
| `option-1` | For local testing. It will automatically configure so that every host is considered to have `127.0.0.1` as their IP address. `option-1` <a href="https://gitlab.zunzun.se/public-items/sampleshop/raw/master/tutorials/tutorial-2.zip" target="_blank">download the demo</a>, place it on www and configure the devlove to serve those files.
| `option-1` | For local testing. It will automatically configure so that every host is considered to have `127.0.0.1` as their IP address. `option-1` <a href="https://gitlab.zunzun.se/public-items/sampleshop/raw/master/tutorials/tutorial-2.zip" target="_blank">download the demo</a>, place it on www and configure the devlove to serve those files.|
| `option-2` | For real sites, with an external origin that is online. |
| `option-3` | For test sites where it is not necessary to be online, the pages will be served from the same vps. Similar to `option-1` (without downloading the demo), ready to be modified according to your requirements. |
| `option-4` | For test sites. Similar to `option-2`, ready to be modified according to your requirements. |
......
......@@ -4,7 +4,7 @@
<details open class="settings"> <!-- Classes: note, danger, settings, admonition example, warning classes, success, -->
<summary>Preliminary requirements</summary>
<ul>
<li>Make sure you have created an <a href="https://docs.accelerator.shimmercat.com/getting-started/getting-started/#1-create-an-authentication-token" target="_blank">authentication token</a>.</li>
<li>Make sure you have created an <a href="https://docs.accelerator.shimmercat.com/getting-started/getting-started.html#create-an-authentication-token" target="_blank">authentication token</a>.</li>
<!--<li>Make sure to have <code>python</code> installed on the Control Node-->
<!-- <sup><a href="https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#control-node-requirements" target="_blank">More info</a></sup> --></li>
<li>Make sure to have <code>ansible</code> installed on your Control Node, see <a href="https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#latest-releases-via-apt-ubuntu" target="_blank">info here</a>.</li>
......@@ -98,27 +98,27 @@ Below are descriptions of the variables that can be configured in the file `grou
|----------|:-------------|
| <i>The below variables can take the values `True` or `False` to define what to install.</i>| <i>We recommend to have all variables `True` in the first run. In subsequent runs you can set them to `False`, except for `run_create_deploys`.</i>|
| `run_install_packages` | Task that updates the server and installs certain packages, for example git, aptitude, python3, pip, and locale. |
| `run_install_requirements` | Task that creates the user and group shimmercat, and uploads the installer for [sc_pack](../../sc-pack/intro-sc-pack). |
| `run_install_requirements` | Task that creates the user and group shimmercat, and uploads the installer for [sc_pack](../explanation/sc-pack/intro-sc-pack.html). |
| `run_install_haproxy` | Task that installs and configures the <a href="http://www.haproxy.org" target="_blank">haproxy load balancer</a>. This is demonized. |
| `run_install_prometheus_node_exporter` | Task that installs the <a href="prometheus.io/docs/guides/node-exporter" target="_blank">prometheus node exporter</a>. Only necessary if you want to create alerts or view and visualize your metrics. |
| `run_install_haproxy_exporter` | Task that installs the <a href="https://github.com/prometheus/haproxy_exporter" target="_blank">haproxy exporter</a>. Only necessary if you want to create alerts or view and visualize your metrics.|
| `run_install_grok_exporter` | Task that installs the <a href="https://github.com/fstab/grok_exporter" target="_blank">grok exporter</a>. Only necessary if you want to create alerts or view and visualize your metrics.|
| `run_update_grok_exporter_config` | You can indicate whether or not you want to update grox exporter config. |
| `run_install_accelerator_client` | Task that installs the [accelerator client](../../accelerator/accelerator-intro/), responsible for registering the domain and the deployment in the Accelerator Platform database, as well as updating the sc_pack configuration, i.e. the sc_pack.conf.yaml file. |
| `run_create_deploys` | Task that creates the new [Deployment Sites](../../accelerator/deployment-sites-and-domains/) instances on the Accelerator Platform database in the cloud (calling the accelerator_client). The task installs and configures sc_pack and updates devlove.yml, sc_pack.conf.yaml, haproxy.cfg, and the views-dir. This is demonized. |
| `run_install_accelerator_client` | Task that installs the [accelerator client](../explanation/accelerator/accelerator-intro.html), responsible for registering the domain and the deployment in the Accelerator Platform database, as well as updating the sc_pack configuration, i.e. the sc_pack.conf.yaml file. |
| `run_create_deploys` | Task that creates the new [Deployment Sites](../explanation/accelerator/deployment-sites-and-domains.html) instances on the Accelerator Platform database in the cloud (calling the accelerator_client). The task installs and configures sc_pack and updates devlove.yml, sc_pack.conf.yaml, haproxy.cfg, and the views-dir. This is demonized. |
| `create_deployment` | You can indicate whether or not you want to create a new deploy and link it to the existing domain. |
| <div style="width:250px">General Variables</div> | Description |
|----------|:-------------|
| `domains` | A list of all domains that will be served by ShimmerCat for all deployments.|
| `origin_cdn_host` | In case you are creating a domain to be used as an image CDN, this would be the origin of the images.|
| `api_access_token`| The <a href="https://docs.accelerator.shimmercat.com/getting-started/getting-started/#1-create-an-authentication-token" target="_blank">authentication token</a> received in the first step of the getting started tutorial.|
| `api_access_token`| The <a href="https://docs.accelerator.shimmercat.com/getting-started/getting-started.html#create-an-authentication-token" target="_blank">authentication token</a> received in the first step of the getting started tutorial.|
| `deployment_tags` | A comma separated string, e.g `"shimmercat,test"`, to identify deployments |
| `installers_dir` | Directory on the server where the executables to be installed will be uploaded. |
| `haproxy_auth_pass` | A password to haproxy that also the haproxy exporter will use. |
| `prometheus_node_exporter_port` | `9112`. Port for the prometheus node exporter. |
| `haproxy_exporter_port` | `9101`. Port for the haproxy exporter.|
| `haproxyconfig_option` | You can choose between four configurations of haproxy-devlove, or create your own. `option-2` is for real sites, with an external origin that is online. `option-1`, `option-3` and `option-4` are for test sites where it is not necessary to be online, the pages will be served from the same vps. You can see the examples of the outputs that are produced in the folders `roles/create_deploys/templates/config/option-<id>/example-results`. See more details in [the haproxyconfig README](about-haproxy.md).|
| `haproxyconfig_option` | You can choose between four configurations of haproxy-devlove, or create your own. `option-2` is for real sites, with an external origin that is online. `option-1`, `option-3` and `option-4` are for test sites where it is not necessary to be online, the pages will be served from the same vps. You can see the examples of the outputs that are produced in the folders `roles/create_deploys/templates/config/option-<id>/example-results`. See more details in [the haproxyconfig README](about-haproxy.html).|
| <div style="width:250px">Deployment Variables</div> | Description |
......@@ -137,7 +137,7 @@ Below are descriptions of the variables that can be configured in the file `grou
| `google_recaptcha_site_secret` | Your Google reCaptcha site secret. Only needed if enable_bots_blocking is True. If needed you should get it from <a href="https://www.google.com/recaptcha/admin/" target="_blank">www.google.com/recaptcha/admin/</a>. |
| `transit_encryption_key` | This will be the encryption key to encrypt and decrypt data sent from the edge servers to the Accelerator Platform and vice versa. Among other things, it is used to synchronize the certificates and their private keys. Make sure to set the same key to all the deployments you would like to synchronize. You choose the key yourself.|
Below is an example setup with two servers. For a <a href='https://docs.accelerator.shimmercat.com/assets/images/setup_overview.svg' target="_blank">more detailed overview check here</a>.
Below is an example setup with two servers. For a <a href='https://docs.accelerator.shimmercat.com/_images/setup_overview.svg' target="_blank">more detailed overview check here</a>.
> __Example overview__
......
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