F5KCK
/
hugo-mx-gateway
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

review all docs

This commit is contained in:
Rodrigue Chakode 2022-04-30 12:04:36 +02:00
parent 8e94f04908
commit 1a3c267b6b
4 changed files with 19 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/deployment-on-docker.md
View File

@ -1,11 +1,10 @@
# Deploying hugo-mx-gateway on Docker # Deploying hugo-mx-gateway on Docker
As described in the below procedure, an instance of `hugo-mx-gateway` can be quickly started on any machine running Docker.
An instance of `hugo-mx-gateway` can be quickly started on any machine running Docker. First review the [configuration variables](./configuration-variables.md).
* Please first review the [configuration variables](#configuration-variables) and adapt them appropriately. Then apply the following command while setting the configuration variables appropriately:
* Then apply the following command:
``` ```
docker run -d \ docker run -d \
@ -22,7 +21,7 @@ An instance of `hugo-mx-gateway` can be quickly started on any machine running D
rchakode/hugo-mx-gateway rchakode/hugo-mx-gateway
``` ```
* Check that the container is up and functionning. Check that the container is up and functionning.
``` ```
curl http://127.0.0.1:8080/ curl http://127.0.0.1:8080/

11
docs/deployment-on-google-compute-engine.md
View File

@ -1,11 +1,20 @@
# Deploying hugo-mx-gateway on Google App Engine # Deploying hugo-mx-gateway on Google App Engine
- [Requirements](#requirements)
- [Setup Procedure](#setup-procedure)
This requires to have an active GCP account and [Google Cloud SDK](https://cloud.google.com/sdk) (gcloud) installed on your work station. ## Requirements
This procedure requires to have:
* an active GCP account.
* [Google Cloud SDK](https://cloud.google.com/sdk) (gcloud) installed and configured on your work station.
* The credentials configured for gcloud must have sufficient permissions to create an App Engine application.
## Setup Procedure
* Create/select a GCP project to deploy `hugo-mx-gateway`. * Create/select a GCP project to deploy `hugo-mx-gateway`.
Note that each GCP project can hold only a single App Engine instance. Several applications can be co-hosted as services for the root App Engine instance. In this case, a new application has to be declared as `service` in the `app.yaml` file. Note that each GCP project can hold only a single App Engine instance. Several applications can be co-hosted as services for the root App Engine instance. In this case, a new application has to be declared as `service` in the `app.yaml` file.
* Create the Google App Engine configuration file * Create the Google App Engine configuration file
``` ```
cp app.yaml.sample app.yaml cp app.yaml.sample app.yaml

5
docs/deployment-on-kubernetes.md
View File

@ -1,9 +1,14 @@
# Deploying hugo-mx-gateway on Kubernetes # Deploying hugo-mx-gateway on Kubernetes
- [Overview](#overview)
- [Setup Procedure](#setup-procedure)
## Overview
From the source tree, the folder `./helm/` contains Helm manifest to ease the deployment of hugo-mx-gateway on Kubernetes clusters. From the source tree, the folder `./helm/` contains Helm manifest to ease the deployment of hugo-mx-gateway on Kubernetes clusters.
> **Important:** The chart is validated with Helm 3 and the pod is run in an unprivileged mode within a **Security Context**. > **Important:** The chart is validated with Helm 3 and the pod is run in an unprivileged mode within a **Security Context**.
## Setup Procedure
Proceed with the deployment as follows: Proceed with the deployment as follows:
* First edit the [values.yaml](./helm/values.yaml) file to set [configuration values](#configuration-variables) appropriately. * First edit the [values.yaml](./helm/values.yaml) file to set [configuration values](#configuration-variables) appropriately.

1
docs/sample-contact-form-for-hugo.md
View File

@ -1,7 +1,6 @@
# Sample contact form for Hugo # Sample contact form for Hugo
- [Sample contact form for Hugo](#sample-contact-form-for-hugo)
- [Overview](#overview) - [Overview](#overview)
- [Setup Procedure](#setup-procedure) - [Setup Procedure](#setup-procedure)