diff --git a/docs/_data/defaults.yml b/docs/_data/defaults.yml new file mode 100644 index 0000000000..9d37f5edf5 --- /dev/null +++ b/docs/_data/defaults.yml @@ -0,0 +1,15 @@ +name: example.com +webhookhandler: webhook.example.com +sshport: 22 +sshhostname: ssh.example.com +apiaddress: api.example.com +helpstring: your Lagoon administrator + +## Comment out any of the above, and uncomment the corresponding below to see the variables in action +# name: amazee.io +# webhookhandler: webhook.amazeeio.cloud +# sshport: 32222 +# sshhostname: ssh.amazeeio.cloud +# apiaddress: api.amazeeio.cloud +# helpstring: "[amazee.io support](https://support.amazee.io)" +# helpstring: "[amazee.io support](mailto:support@amazee.io)" diff --git a/docs/applications/drupal/first-deployment-of-drupal.md b/docs/applications/drupal/first-deployment-of-drupal.md index 2dfa6aec71..1006fc95b2 100644 --- a/docs/applications/drupal/first-deployment-of-drupal.md +++ b/docs/applications/drupal/first-deployment-of-drupal.md @@ -19,13 +19,13 @@ git push This will trigger a push, and the Git hosting will inform Lagoon about this push via the configured webhook. -If all is correct, you will see a notification in your configured chat system (this is configured by your friendly Lagoon administrator): +If all is correct, you will see a notification in your configured chat system \(Contact {{ defaults.helpstring }} for this\): ![Slack notification of a deployment starting.](../../images/first_deployment_slack_start.jpg) This tells you that Lagoon has just started to deploy your code. Depending on the size of the codebase and amount of containers, this will take a couple of seconds. Just relax. If you'd like to know what's happening now, check out the [Build and Deploy Process of Lagoon](../../concepts-basics/build-and-deploy-process.md). -You can also check your Lagoon UI to see the progress of any deployment (your Lagoon administrator has the info). +You can also check your Lagoon UI to see the progress of any deployment \(Contact {{ defaults.helpstring }} for this\). ## 3. A fail @@ -141,4 +141,4 @@ That's the beauty of Lagoon: it's exactly the same: Push the branch name you def Did the deployment fail? Oh no! But we're here to help: 1. Click on the `logs` link in the error notification. It will tell you where in the deployment process the failure happened. -2. If you can't figure it out, ask your Lagoon administrator, they are here to help! +2. If you can't figure it out, contact {{ defaults.helpstring }}, they are here to help! diff --git a/docs/concepts-advanced/environment-idling.md b/docs/concepts-advanced/environment-idling.md index d91c9354f7..69423232e1 100644 --- a/docs/concepts-advanced/environment-idling.md +++ b/docs/concepts-advanced/environment-idling.md @@ -6,7 +6,7 @@ Lagoon can utilize the [Aergia controller](https://github.com/amazeeio/aergia-co ### How does an environment get idled? -The environment idler has many different configuration capabilities. Here are the defaults of a standard Lagoon installation \(these could be quite different in your Lagoon, check with your Lagoon administrator!\) +The environment idler has many different configuration capabilities. Here are the defaults of a standard Lagoon installation \(these could be quite different in your Lagoon, Contact {{ defaults.helpstring }}!\) * Idling is tried every 4 hours. * Production environments are never idled. @@ -25,4 +25,4 @@ The un-idling will take a couple of seconds, as the Kubernetes cluster needs to Yes, there is a field `autoIdle` on the project \(impacts all environments\) and environment \(if you need to target just one environment\), as to whether idling is allowed to take place. A value of `1` indicates the project/environment is eligible for idling. If the project is set to `0` the environments will never be idled, even if the environment is set to `0` The default is always `1`\(idling is enabled\). -Talk to your Lagoon administrator if you are unsure how to set these project/environment fields. +Contact {{ defaults.helpstring }} if you are unsure how to set these project/environment fields. diff --git a/docs/concepts-advanced/environment-types.md b/docs/concepts-advanced/environment-types.md index d1963cc757..fa7ba8f9b1 100644 --- a/docs/concepts-advanced/environment-types.md +++ b/docs/concepts-advanced/environment-types.md @@ -11,7 +11,7 @@ But that's it. Lagoon itself handles `development` and `production` environments There are a couple of things that will use this information: -* By default, `development` environments are idled after 4 hours with no hits \(don't worry, they wake up automatically\). It is also possible for your Lagoon administrator to disable auto-idling on a per-environment basis, just ask! +* By default, `development` environments are idled after 4 hours with no hits \(don't worry, they wake up automatically\). It is also possible for {{ defaults.helpstring }} to disable auto-idling on a per-environment basis, just ask! * Our default Drupal `settings.php` files load additional settings files for `development.settings.php` and `production.settings.php` so you can define settings and configurations different per environment type. * If you try to delete an environment that is defined as the production environment \(either via webhooks or REST\), Lagoon will politely refuse to delete the production environment, as it tries to prevent you from making a mistake. In order to delete a production environment, you can either change the `productionEnvironment` in the API or use the secret `forceDeleteProductionEnvironment: true` POST payload for the REST API. -* The Lagoon administrator might use the production environment information for some additional things. For example, at amazee.io we're calculating only the hits of the production environments to calculate the price of the hosting. +* {{ defaults.helpstring }} might use the production environment information for some additional things, such as calculating only the hits of the production environments to calculate the price of the hosting. diff --git a/docs/concepts-basics/docker-compose-yml.md b/docs/concepts-basics/docker-compose-yml.md index 79199f065e..6fd084978a 100644 --- a/docs/concepts-basics/docker-compose-yml.md +++ b/docs/concepts-basics/docker-compose-yml.md @@ -145,8 +145,8 @@ In many cases, Lagoon knows where that persistent storage needs to go. For examp * `lagoon.persistent` - The **absolute** path where the persistent storage should be mounted (the above example uses `/app/web/sites/default/files/` which is where Drupal expects its persistent storage). * `lagoon.persistent.name` - Tells Lagoon to not create a new persistent storage for that service, but instead mounts the persistent storage of another defined service into this service. -* `lagoon.persistent.size` - The size of persistent storage you require (Lagoon usually gives you minimum 5G of persistent storage, if you need more, define it here). -* `lagoon.persistent.class` - By default Lagoon automatically assigns the right storage class for your service (like SSDs for MySQL, bulk storage for Nginx, etc.). If you need to overwrite this, you can do so here. This is highly dependent on the underlying Kubernetes/OpenShift that Lagoon runs on. Ask your Lagoon administrator about this. +* `lagoon.persistent.size` - The size of persistent storage you require \(Lagoon usually gives you minimum 5G of persistent storage, if you need more, define it here\). +* `lagoon.persistent.class` - By default Lagoon automatically assigns the right storage class for your service \(like SSDs for MySQL, bulk storage for Nginx, etc.\). If you need to overwrite this, you can do so here. This is highly dependent on the underlying Kubernetes/OpenShift that Lagoon runs on. Contact {{ defaults.helpstring }} for this. ### Auto-generated Routes diff --git a/docs/concepts-basics/lagoon-yml.md b/docs/concepts-basics/lagoon-yml.md index 21add8f274..93f57836de 100644 --- a/docs/concepts-basics/lagoon-yml.md +++ b/docs/concepts-basics/lagoon-yml.md @@ -271,7 +271,10 @@ that's important!): !!! Info If you plan to switch from a SSL certificate signed by a Certificate Authority (CA) to a Let's Encrypt certificate, it's best to get in touch - with your Lagoon administrator to oversee the transition. + with {{ defaults.helpstring }} to oversee the transition. There are [known + issues](https://github.com/tnozicka/openshift-acme/issues/68) during the + transition. The workaround would be manually removing the CA certificate and + then triggering the Let's Encrypt process. ### Monitoring a specific path @@ -285,7 +288,7 @@ When [UptimeRobot](https://uptimerobot.com/) is configured for your cluster \(Ku ### Ingress annotations !!! Warning - Route/Ingress annotations are only supported by projects that deploy into clusters that run nginx-ingress controllers! Check with your Lagoon administrator if this is supported. + Route/Ingress annotations are only supported by projects that deploy into clusters that run nginx-ingress controllers! Check with {{ defaults.helpstring }} if this is supported. * `annotations` can be a YAML map of [annotations supported by the nginx-ingress controller](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/). This is specifically useful for easy redirects and other configurations. @@ -506,14 +509,14 @@ poly-project2: ???+ Info If you run directly on amazee.io hosted Lagoon you will not need this key set. -With the key `api` you can define another URL that should be used by the Lagoon CLI and `drush` to connect to the Lagoon GraphQL API. This needs to be a full URL with a scheme, like: `http://localhost:3000` This usually does not need to be changed, but there might be situations where your Lagoon administrator tells you to do so. +With the key `api` you can define another URL that should be used by the Lagoon CLI and `drush` to connect to the Lagoon GraphQL API. This needs to be a full URL with a scheme, like: `http://localhost:3000` This usually does not need to be changed, but there might be situations where {{ defaults.helpstring }} tells you to do so. ### `ssh` ???+ Info If you run directly on amazee.io hosted Lagoon you will not need this key set. -With the key `ssh` you can define another SSH endpoint that should be used by the Lagoon CLI and `drush` to connect to the Lagoon remote shell service. This needs to be a hostname and a port separated by a colon, like: `localhost:2020` This usually does not need to be changed, but there might be situations where your Lagoon administrator tells you to do so. +With the key `ssh` you can define another SSH endpoint that should be used by the Lagoon CLI and `drush` to connect to the Lagoon remote shell service. This needs to be a hostname and a port separated by a colon, like: `localhost:2020` This usually does not need to be changed, but there might be situations where {{ defaults.helpstring }} tells you to do so. ### `container-registries` diff --git a/docs/interacting/graphql.md b/docs/interacting/graphql.md index 9a45cb95f6..c2975d7cd3 100644 --- a/docs/interacting/graphql.md +++ b/docs/interacting/graphql.md @@ -10,17 +10,17 @@ To generate this token, use the remote shell via the `token` command: ssh -p [PORT] -t lagoon@[HOST] token ``` -Example for amazee.io: +{{ defaults.name }} connection string: -```bash title="Get amazee.io token" -ssh -p 32222 -t lagoon@ssh.lagoon.amazeeio.cloud token +```bash title="Get {{ defaults.name }} token" +ssh -p {{ defaults.sshport }} -t lagoon@{{ defaults.sshhostname }} token ``` This will return a long string, which is the JWT token. -We also need the URL of the API endpoint. Ask your Lagoon administrator for this. +We also need the URL of the API endpoint. {{ defaults.helpstring }} for this. -On amazee.io this is [`https://api.lagoon.amazeeio.cloud/graphql`](https://api.lagoon.amazeeio.cloud/graphql). +For {{ defaults.name }} this is [`https://{{ defaults.apiaddress }}/graphql`](https://{{ defaults.apiaddress }}/graphql/graphql). Now we need a GraphQL client! Technically this is just HTTP, but we suggest GraphiQL. It has a nice UI that allows you to write GraphQL requests with autocomplete. Download, install and start it. \[[GraphiQL App](https://github.com/skevy/graphiql-app)\] diff --git a/docs/interacting/ssh.md b/docs/interacting/ssh.md index 6586a27028..86dcae2f2b 100644 --- a/docs/interacting/ssh.md +++ b/docs/interacting/ssh.md @@ -62,14 +62,14 @@ Connecting is straightforward and follows the following pattern: ssh -p [PORT] -t [PROJECT-ENVIRONMENT-NAME]@[HOST] ``` -* `PORT` - The remote shell SSH endpoint port (for amazee.io: `32222`). -* `HOST` - The remote shell SSH endpoint host (for amazee.io `ssh.lagoon.amazeeio.cloud`). +* `PORT` - The remote shell SSH endpoint port (for example: `{{ defaults.sshport }}`). +* `HOST` - The remote shell SSH endpoint host (for example `{{ defaults.sshhostname }}`). * `PROJECT-ENVIRONMENT-NAME` - The environment you want to connect to. This is most commonly in the pattern `PROJECTNAME-ENVIRONMENT`. As an example: ```bash title="SSH example" -ssh -p 32222 -t drupal-example-main@ssh.lagoon.amazeeio.cloud +ssh -p {{ defaults.sshport }} -t drupal-example-main@{{ defaults.sshhostname }} ``` This will connect you to the project `drupal-example` on the environment `main`. @@ -91,7 +91,7 @@ ssh -p [PORT] -t [PROJECT-ENVIRONMENT-NAME]@[HOST] service=[SERVICE-NAME] contai For example, to connect to the `php` container within the `nginx` pod: ```bash title="SSH to php container" -ssh -p 32222 -t drupal-example-main@ssh.lagoon.amazeeio.cloud service=nginx container=php +ssh -p {{ defaults.sshport }} -t drupal-example-main@{{ defaults.sshhostname }} service=nginx container=php ``` ## Copying files @@ -101,19 +101,19 @@ The common case of copying a file into your `cli` pod can be acheived with the u ### scp ```bash title="Copy file with scp" -scp -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -P 32222 [local_path] [project_name]-[environment_name]@ssh.lagoon.amazeeio.cloud:[remote_path] +scp -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -P {{ defaults.sshport }} [local_path] [project_name]-[environment_name]@{{ defaults.sshhostname }}:[remote_path] ``` ### rsync ```bash title="Copy files with rsync" -rsync --rsh='ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 32222' [local_path] [project_name]-[environment_name]@ssh.lagoon.amazeeio.cloud:[remote_path] +rsync --rsh='ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p {{ defaults.sshport }}' [local_path] [project_name]-[environment_name]@{{ defaults.sshhostname }}:[remote_path] ``` ### tar ```bash -ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -P 32222 [project_name]-[environment_name]@ssh.lagoon.amazee.io tar -zcf - [remote_path] | tar -zxf - -C /tmp/ +ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -P {{ defaults.sshport }} [project_name]-[environment_name]@{{ defaults.sshhostname }} tar -zcf - [remote_path] | tar -zxf - -C /tmp/ ``` ### Specifying non-CLI pod/service @@ -123,7 +123,7 @@ In the rare case that you need to specify a non-CLI service you can specify the Piping `tar` through the `ssh` connection is the simplest method, and can be used to copy a file or directory using the usual `tar` flags: ```bash -ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -P 32222 [project_name]-[environment_name]@ssh.lagoon.amazee.io service=solr tar -zcf - [remote_path] | tar -zxf - -C /tmp/ +ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -P {{ defaults.sshport }} [project_name]-[environment_name]@{{ defaults.sshhostname }} service=solr tar -zcf - [remote_path] | tar -zxf - -C /tmp/ ``` You can also use `rsync` with a wrapper script to reorder the arguments to `ssh` in the manner required by Lagoon's SSH service: @@ -132,13 +132,13 @@ You can also use `rsync` with a wrapper script to reorder the arguments to `ssh` #!/usr/bin/env sh svc=$1 user=$3 host=$4 shift 4 -exec ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 32222 -l "$user" "$host" "$svc" "$@" +exec ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p {{ defaults.sshport }} -l "$user" "$host" "$svc" "$@" ``` Put that in an executable shell script `rsh.sh` and specify the `service=...` in the `rsync` command: ```bash title="rsync to non-CLI pod" -rsync --rsh="/path/to/rsh.sh service=cli" /tmp/foo [project_name]-[environment_name]@ssh.lagoon.amazeeio.cloud:/tmp/foo +rsync --rsh="/path/to/rsh.sh service=cli" /tmp/foo [project_name]-[environment_name]@{{ defaults.sshhostname }}:/tmp/foo ``` The script could also be adjusted to also handle a `container=...` argument. diff --git a/docs/logging/logging.md b/docs/logging/logging.md index 0377d071fa..02b237d20c 100644 --- a/docs/logging/logging.md +++ b/docs/logging/logging.md @@ -31,7 +31,7 @@ Lagoon provides access to the following logs via Kibana: * Ensure logs are structured as JSON encoded objects. * Ensure the `type` field contains the name of the Kubernetes namespace (`$LAGOON_PROJECT-$LAGOON_ENVIRONMENT`). -To access the logs, please check with your Lagoon administrator to get the URL for the Kibana route \(for amazee.io, this is [https://logs.amazeeio.cloud/](https://logs.amazeeio.cloud/)\). +To access the logs, please contact {{ defaults.helpstring }} to get the URL for the Kibana route. Each Lagoon user account has their own login and will see the logs only for the projects to which they have access. diff --git a/docs/requirements.txt b/docs/requirements.txt index 1ee97fca86..dd0be593cc 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,4 +2,5 @@ mkdocs-material mkdocs-redirects mdx_truly_sane_lists mkdocs-git-revision-date-localized-plugin -mkdocs-awesome-pages-plugin \ No newline at end of file +mkdocs-awesome-pages-plugin +mkdocs-markdownextradata-plugin diff --git a/docs/resources/faq.md b/docs/resources/faq.md index f1c0542a17..c7d6e257a0 100644 --- a/docs/resources/faq.md +++ b/docs/resources/faq.md @@ -1,12 +1,12 @@ # FAQ -## How do I contact my Lagoon administrator? +## I found a bug! 🐞 -You should have a private Slack channel that was set up for you to communicate - if not, or you've forgotten how to contact us, reach out at [support@amazee.io](mailto:support@amazee.io). +If you've found a bug, please raise a GitHub issue for it, or contact {{ defaults.helpstring }}. -## I found a bug! 🐞 +## I found a security issue! 🐞 -If you've found a bug or security issue, please send your findings to [support@amazee.io](mailto:support@amazee.io). Please DO NOT file a GitHub issue for them. +If you've found a security issue, please send your findings to [security@amazee.io](mailto:security@amazee.io). Please DO NOT file a GitHub issue for it. ## I'm interested in amazee.io's hosting services with Lagoon @@ -85,7 +85,7 @@ This typically indicates an issue with Pygmy. You can find our troubleshooting d ## How do I remove a route? -Lagoon will detect the removal of routes from your `.lagoon.yml` during a deployment. Check the deployment logs to confirm that the routes were removed automatically or for instructions on how to remove them. +Lagoon will detect the removal of routes from your `.lagoon.yml` during a deployment. Check the deployment logs to confirm that the routes were removed automatically or for instructions on how to remove them. You may also contact {{ defaults.helpstring }} if you need to remove a route. ## When I run `pygmy status`, no keys are loaded @@ -173,4 +173,4 @@ We suggest only exposing web services (NGINX/Varnish/Node.js) in your deployed e ## I have a question that isn't answered here -You can reach out to the team via [Discord](https://discord.gg/te5hHe95JE) or email at [uselagoon@amazee.io](mailto:uselagoon@amazee.io). +You should contact {{ defaults.helpstring }} for any hosting-related enquiries, but you can also reach out to the Lagoon team via [Discord](https://discord.gg/te5hHe95JE) or email at [uselagoon@amazee.io](mailto:uselagoon@amazee.io). diff --git a/docs/using-lagoon-advanced/using-harbor/README.md b/docs/using-lagoon-advanced/using-harbor/README.md index 4e2079523c..bb5fa50281 100644 --- a/docs/using-lagoon-advanced/using-harbor/README.md +++ b/docs/using-lagoon-advanced/using-harbor/README.md @@ -8,7 +8,7 @@ If you are running Lagoon locally, you can access that UI at [localhost:8084](https://localhost:8084/). The username is `admin` and the password is `admin`. !!! Note - If you are hosting a site with a provider (such as amazee.io), they may not allow customer access to the Harbor UI. + If you are hosting a site with a provider, they may not allow customer access to the Harbor UI. Once logged in, the first screen is a list of all repositories your user has access to. Each "repository" in Harbor correlates to a project in Lagoon. diff --git a/docs/using-lagoon-the-basics/configure-webhooks.md b/docs/using-lagoon-the-basics/configure-webhooks.md index 94fc3b9a71..c85338c335 100644 --- a/docs/using-lagoon-the-basics/configure-webhooks.md +++ b/docs/using-lagoon-the-basics/configure-webhooks.md @@ -1,10 +1,10 @@ # Configure Webhooks -Your Lagoon administrator will also give you the route to the `webhook-handler`. You will add this to your repository as an outgoing webhook, and choose which events to send to Lagoon. Typically, you will send all push and pull request events. In Lagoon it is possible to add a regular expression to determine which branches and pull requests actually result in a deploy, and your Lagoon administrator can set that up for you. For example, all branches that start with `feature-` could be deployed to Lagoon. +Ask {{ defaults.helpstring }} to give you the route to the `webhook-handler`. You will add this to your repository as an outgoing webhook, and choose which events to send to Lagoon. Typically, you will send all push and pull request events. In Lagoon it is possible to add a regular expression to determine which branches and pull requests actually result in a deploy, and {{ defaults.helpstring }} can set that up for you. For example, all branches that start with `feature-` could be deployed to Lagoon. -???+ Info "Info for amazee.io customers" - If you are an amazee.io customer, the route to the webhook-handler is: [`https://hooks.lagoon.amazeeio.cloud`](https://hooks.lagoon.amazeeio.cloud). +???+ Info "{{ defaults.name }} webhook details" + [`https://{{ defaults.webhookhandler }}`](https://{{ defaults.webhookhandler }}) !!! danger @@ -14,7 +14,7 @@ Your Lagoon administrator will also give you the route to the `webhook-handler`. 1. Proceed to Settings -> Webhooks -> `Add webhook` in your GitHub repository. ![Adding webhook in GitHub.](../images/webhooks-2020-01-23-12-40-16.png) -2. The `Payload URL` is the route to the `webhook-handler` of your Lagoon instance, provided by your Lagoon administrator. +2. The `Payload URL` is the route to the `webhook-handler` of your Lagoon instance, contact {{ defaults.helpstring }} for this. 3. Set `Content type` to `application/json`. ![Add the Payload URL and set the Content type.](../images/gh_webhook_1.png) 4. Choose "`Let me select individual events`." @@ -27,7 +27,7 @@ Your Lagoon administrator will also give you the route to the `webhook-handler`. 1. Navigate to Settings -> Integrations in your GitLab repository. ![Go to Settings > Integrations in your GitLab repository.](../images/gitlab-settings.png) -2. The `URL` is the route to the `webhook-handler` of your Lagoon instance, provided by your Lagoon administrator. +2. The `URL` is the route to the `webhook-handler` of your Lagoon instance, contact {{ defaults.helpstring }} for this. 3. Select the `Trigger` events which will send a notification to Lagoon. We suggest that you send `Push events` and `Merge request events`, and then filter further in the Lagoon configuration of your project. ![Selecting Trigger events in GitLab.](../images/gitlab_webhook.png) 4. Click `Add webhook`to save your configuration. @@ -36,7 +36,7 @@ Your Lagoon administrator will also give you the route to the `webhook-handler`. 1. Navigate to Settings -> Webhooks -> Add new webhook in your repository. 2. `Title` is for your reference. -3. `URL` is the route to the `webhook-handler` of your Lagoon instance, provided by your Lagoon administrator. +3. `URL` is the route to the `webhook-handler` of your Lagoon instance, contact {{ defaults.helpstring }} for this. 4. `Choose from a full list of triggers` and select the following: * Repository diff --git a/docs/using-lagoon-the-basics/first-deployment.md b/docs/using-lagoon-the-basics/first-deployment.md index 559b941911..399743c181 100644 --- a/docs/using-lagoon-the-basics/first-deployment.md +++ b/docs/using-lagoon-the-basics/first-deployment.md @@ -28,13 +28,13 @@ git push This will trigger a push, and your Git hosting will inform Lagoon about this push via the configured webhook. -If all is correct, you should see a notification in your configured chat system \(this has been configured by your friendly Lagoon administrator\): +If all is correct, you should see a notification in your configured chat system \(Contact {{ defaults.helpstring }} for this\): ![Slack notification that a push has been made in a Lagoonized repository.](../images/first_deployment_slack_start.jpg) This informs you that Lagoon has just started to deploy your code. Depending on the size of the code and amount of containers, this will take a couple of seconds. Just relax. If you want to know what's happening now, check out the [Build and Deploy Process of Lagoon](../concepts-basics/build-and-deploy-process.md). -You can also check your Lagoon UI to see the progress of any deployment \(your Lagoon administrator has the info\). +You can also check your Lagoon UI to see the progress of any deployment \(Contact {{ defaults.helpstring }} for this\). ## 3. It's done diff --git a/docs/using-lagoon-the-basics/going-live.md b/docs/using-lagoon-the-basics/going-live.md index 73f27c8dc4..dfad7200b2 100644 --- a/docs/using-lagoon-the-basics/going-live.md +++ b/docs/using-lagoon-the-basics/going-live.md @@ -8,7 +8,7 @@ Congratulations, you're _this_ close to going live with your website on Lagoon! Check to be sure that all routes have been set up in your `.lagoon.yml`. Be aware that if you don't point the domains towards Lagoon, you should disable Let's Encrypt \(LE\) certificate creation, as it will lead to issues. Domains not pointing towards Lagoon will be disabled after a while in order to not exceed the Let's Encrypt quotas. -If you use Certificate Authority \(CA\) signed certificates, you can set `tls-acme` to `false` , but leave the `insecure` flag set to `Allow` or `Redirect`. In the case of CA certificates, let your Lagoon administrator know the routes and the SSL certificate that needs to be put in place. +If you use Certificate Authority \(CA\) signed certificates, you can set `tls-acme` to `false` , but leave the `insecure` flag set to `Allow` or `Redirect`. In the case of CA certificates, contact {{ defaults.helpstring }} with the routes and the SSL certificate that needs to be put in place. ```yaml title=".lagoon.yml" environments: @@ -51,7 +51,7 @@ Check if your cron jobs have been set up for your production environment - see [ ## DNS -To make it as smooth as possible for you to get your site pointing to our servers, we have dedicated load-balancer DNS records. Those technical DNS resource records are used for getting your site linked to the amazee.io infrastructure and serve no other purpose. If you are in doubt of the CNAME record, ask your Lagoon administrator about the exact CNAME you need to set up. +To make it as smooth as possible for you to get your site pointing to our servers, we have dedicated load-balancer DNS records. Those technical DNS resource records are used for getting your site linked to the amazee.io infrastructure and serve no other purpose. If you are in doubt of the CNAME record, contact {{ defaults.helpstring }} about the exact CNAME you need to set up. **Example on amazee.io :** `.amazee.io` @@ -86,7 +86,7 @@ Configuring the root domain \(e.g. example.com\) can be a bit tricky because the * CNAME at [CloudFlare](https://www.cloudflare.com/) * CNAME at [NS1](http://ns1.com) -If your DNS provider needs an IP address for the root domain, get in touch with your Lagoon administrator to give you the load balancer IP addresses. +If your DNS provider needs an IP address for the root domain, get in touch contact {{ defaults.helpstring }} to give you the load balancer IP addresses. ## Production environment @@ -94,6 +94,6 @@ Lagoon understands the concept of development and production environments. Devel `X-Robots-Tag: noindex, nofollow` -During project setup, the production environment should already be defined. If that's omitted, your environment will run in development mode. You can check if the environment is set as production environment in the Lagoon user interface. If the production environment is not set, let your Lagoon administrator know, and they will configure the system accordingly. +During project setup, the production environment should already be defined. If that's omitted, your environment will run in development mode. You can check if the environment is set as production environment in the Lagoon user interface. If the production environment is not set, let {{ defaults.helpstring }} know, and they will configure the system accordingly. ![The production environment is labelled in green on the left. ](../images/lagoon-ui-production.png) diff --git a/docs/using-lagoon-the-basics/local-development-environments.md b/docs/using-lagoon-the-basics/local-development-environments.md index 3d7faa6121..5c35ba0a92 100644 --- a/docs/using-lagoon-the-basics/local-development-environments.md +++ b/docs/using-lagoon-the-basics/local-development-environments.md @@ -14,7 +14,7 @@ Even though Lagoon has only a hard dependency on Docker and [Docker Compose](htt ### pygmy -Lagoon has traditionally worked best with `pygmy` , which is the amazee.io flavored system of the above tools and works out of the box with Lagoon. It lives at [https://github.com/pygmystack/pygmy](https://github.com/pygmystack/pygmy) +Lagoon has traditionally worked best with `pygmy` , which is a preconfigured system of the above tools and works out of the box with Lagoon. It lives at [https://github.com/pygmystack/pygmy](https://github.com/pygmystack/pygmy) `pygmy` is written in Golang, so to install it, run: diff --git a/docs/using-lagoon-the-basics/setup-project.md b/docs/using-lagoon-the-basics/setup-project.md index 32a29e747f..ab818dff07 100644 --- a/docs/using-lagoon-the-basics/setup-project.md +++ b/docs/using-lagoon-the-basics/setup-project.md @@ -3,9 +3,9 @@ !!! Note We are working hard on getting our CLI and GraphQL API set up to allow everyone using Lagoon to set up and configure their projects themselves. Right now, it needs more testing before we can release those features, so hold tight! -Until then, the setup of a new project involves talking to your Lagoon administrator, which is ok, as they are much friendlier than APIs. 😊 +Until then, the setup of a new project involves talking to {{ defaults.helpstring }}, which is ok, as they are much friendlier than APIs. 😊 -Please have the following information ready for your Lagoon administrator: +Please have the following information ready for {{ defaults.helpstring }}: * A name you would like the project to be known by * This name can only contain lowercase characters, numbers and dashes @@ -13,7 +13,7 @@ Please have the following information ready for your Lagoon administrator: * SSH public keys, email addresses and the names of everybody that will work on this project. Here are instructions for generating and copying SSH keys for [GitHub](https://help.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh), [GitLab](https://docs.gitlab.com/ee/ssh/), and [Bitbucket](https://confluence.atlassian.com/bitbucket/set-up-an-ssh-key-728138079.html). * The URL of the Git repository where your code is hosted \(`git@example.com:test/test.git`\). * The name of the Git branch you would like to use for your production environment \(see [Environment Types](../concepts-advanced/environment-types.md) for details about the environments\). -* Which branches and pull requests you would like to deploy to your additional environments. With Lagoon, you can filter branches and pull requests by name with regular expressions, and your Lagoon administrator can get this set up for you. +* Which branches and pull requests you would like to deploy to your additional environments. With Lagoon, you can filter branches and pull requests by name with regular expressions, and {{ defaults.helpstring }} can get this set up for you. We suggest deploying specific important branches \(like `develop` and `main`\) and pull requests. But that's all up to you! \(see [Workflows](../concepts-advanced/workflows.md) for some more information\) @@ -27,7 +27,7 @@ If this is not the case, check out the list of [Step-by-Step Guides](index.md#st In order to deploy your code, Lagoon needs access to it. By design and for security, Lagoon only needs read access to your Git repository. -Your Lagoon administrator will tell you the SSH public key or the Git account to give read access to. +{{ defaults.helpstring }} will tell you the SSH public key or the Git account to give read access to. ## 3. Configure Webhooks diff --git a/mkdocs.yml b/mkdocs.yml index 05f3d0550e..5edbc17845 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -240,6 +240,7 @@ markdown_extensions: plugins: - search - awesome-pages + - markdownextradata - redirects: redirect_maps: # Shortcut URLs for build and compose errors