Skip to content

Commit

Permalink
Fix some obvious typos and spelling mistakes and polish a bit.
Browse files Browse the repository at this point in the history
  • Loading branch information
jonasbardino committed Apr 2, 2024
1 parent 7e653d5 commit df4c16c
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 27 deletions.
2 changes: 1 addition & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Welcome to Docker MiGrid
**Note! This documentation is currently WIP.**

Docker MiGrid provides a prepackaged build of the Minimum Intrusion Grid (MiG) middleware system.
It does this, by building and deploying the MiG across a number of Docker containers, that each is tasked with delievering a single or multiple MiG service(s).
It does this, by building and deploying the MiG across a number of Docker containers, that each is tasked with delivering a single or multiple MiG service(s).

To jump right into having your own version of MiGrid deployed, please
read on in
Expand Down
4 changes: 2 additions & 2 deletions doc/source/sections/configuration/variables.rst
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ Variables
- Which web design and site to use as a basis when generating the instance web pages
* - EMULATE_FQDN
- migrid.org
- The FQDN of the site on the basis siste to replace with the one of this instance
- The FQDN of the site on the basis site to replace with the one of this instance
* - SKIN_SUFFIX
- basic
- Which skin variant to use as a basis. If flavor is migrid and skin suffix is basic the skin in migrid-basic will effectively be used.
Expand Down Expand Up @@ -429,4 +429,4 @@ Variables
- Where the optional external Jupyter nodes can be reached
* - JUPYTER_SERVICES_DESC
- "{}"
- A text to decribe the optional external Jupyter nodes
- A text to describe the optional external Jupyter nodes
6 changes: 3 additions & 3 deletions doc/source/sections/getting-started/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Overview

Before you can build an image, you need to select which MiGrid services you would like to run.
This choice will lead you to select or configure an environment file that suit your particular choice.
There are different predefined environments available in this repository (eg. `development.env` or `production.env`).
There are different predefined environments available in this repository (e.g. `development.env` or `production.env`).

After choosing an environment and adapting it to your needs, you can enable it by creating an .env symlink that points to your particular environment configuration.
For instance, if you want to build the MiGrid image with the default environment settings, this is achieved by the Makefile init target, which will automatically create a symlink from development.env to the expected .env file. If this behaviour is not wanted, a symlink has to be manually created before make is called to link the designated environment file to the .env file. For instance::
Expand All @@ -25,7 +25,7 @@ If you just want to get started right away without any configuration changes you
make up

The Makefile takes care of creating all the necessary files, builds a migrid image and starts up the services.
The entire process should be succesfully completed, when the following lines have been printed::
The entire process should be successfully completed, when the following lines have been printed::

[+] Running 15/15
✔ Network docker-migrid_default Created 0.0s
Expand Down Expand Up @@ -72,7 +72,7 @@ The result of executing the `init` Makefile target can be seen below::
mkdir -p state

Finally, once the repository directory has been initialized, the Docker MiGrid image is ready to be built.
This is achieved with the `build` target inside the Makefile. By executing this, the image build process will comence, an example of this can be seen below::
This is achieved with the `build` target inside the Makefile. By executing this, the image build process will commence, an example of this can be seen below::

docker-compose build
WARNING: Python-dotenv could not parse statement starting at line 5
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Please note that Rocky 8 uses a central systemd conf in
/etc/crypto-policies/back-ends/opensshserver.config for configuring
Ciphers, KexAlgorithms and MACs rather than the usual
/etc/sshd/sshd_config. You can remove those and check that the sshd
processs does not run with them hard-coded on the command line based
process does not run with them hard-coded on the command line based
on the output of::
ps ax|grep sshd
Expand Down
14 changes: 7 additions & 7 deletions doc/source/sections/getting-started/deploying.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ To stop the services, execute the following command::

make down

After this command has been executed succesfully it should have launched the 4 following containers::
After this command has been executed successfully it should have launched the 4 following containers::

CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
419e4ede2af3 ucphhpc/migrid:basic "/tini -- /app/docke…" 4 minutes ago Up 4 minutes 80/tcp, 0.0.0.0:2222->2222/tcp, :::2222->2222/tcp, 0.0.0.0:4443->4443/tcp, :::4443->4443/tcp, 0.0.0.0:8021->8021/tcp, :::8021->8021/tcp, 0.0.0.0:8443->8443/tcp, :::8443->8443/tcp, 443-448/tcp, 0.0.0.0:22222->22222/tcp, :::22222->22222/tcp migrid-io
Expand Down Expand Up @@ -63,7 +63,7 @@ After this is completed, you should be able to access the basic MiGrid page via
https://migrid.test

If you are running `docker-migrid` on a remote server, this might give you a redirection error. If so try the following URL instead.
If neither of these two URLs takes you to the decribed OpenID login page. Please get in touch with us.::
If neither of these two URLs takes you to the described OpenID login page. Please get in touch with us.::

https://ext.migrid.test

Expand All @@ -86,10 +86,10 @@ With these credentials, the authentication should redirect you to the Welcome pa
DNS setup for production
------------------------

When running MiGrid in production, DNS is usually handled by an external service. Also a major difference might be that all HTTPs services should run on port 443 to be reachable by client without further knowledge.
When running MiGrid in production, DNS is usually handled by an external service. Also a major difference might be that all HTTPS services should run on port 443 to be reachable by client without further knowledge.

To achive that docker-migird usually runs on multiple IP addresses instead of using SNI.
This way is doesn't matter in how many seperate servers the setup is splitted.
To achieve that docker-migrid usually runs on multiple IP addresses instead of using SNI.
This way is doesn't matter in how many separate servers the setup is split.
At least 5 IP addresses are used by default to seperate different services from each other:

.. list-table:: Standard IP address setup
Expand All @@ -101,10 +101,10 @@ At least 5 IP addresses are used by default to seperate different services from
- Description
* - migrid.test \*.migrid.test
- 10.0.0.1
- The webinterface (frontpage) with infos and login screen (``$DOMAIN``, ``$WILDCARD_DOMAIN``)
- The web interface (front page) with info and login screen (``$DOMAIN``, ``$WILDCARD_DOMAIN``)
* - ext.migrid.test
- 10.0.0.2
- Handles migrids OWN OpenID (``$MIGOID_DOMAIN``)
- Handles migrid's OWN OpenID (``$MIGOID_DOMAIN``)
* - oid.migrid.test
- 10.0.0.3
- Handles the external OpenID (``$EXTOID_DOMAIN``)
Expand Down
17 changes: 7 additions & 10 deletions doc/source/sections/getting-started/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@ Introduction
============

Before we can get started with Docker MiGrid, a good place to start, is to get an understanding of the repository itself and how it is structured.
This repository provides a ``Makefile`` which allows fast and easy setup and teardown of docker-migrid deployments.
A deployment is definded by a set of environment variables and corresponding ``docker-compose.yml`` and ``Dockerfile`` files.
This repository provides a ``Makefile`` which allows fast and ease setup and tear-down of docker-migrid deployments.
A deployment is defined by a set of environment variables and corresponding ``docker-compose.yml`` and ``Dockerfile`` files.

.. image:: ../../res/images/docker-compose-workflow.png

Docker MiGrid Structure
-----------------------

The Docker MiGrid is build up of several different components and services.
These have been seperated into two different categories, Associated services and MiGrid services.
These have been separated into two different categories, Associated services and MiGrid services.

Example Deployments
-------------------
Expand Down Expand Up @@ -85,13 +85,10 @@ The MiGrid services are composed of a number of different container services tha

.. _migrid_io_desc:

- migrid-io
The migrid-io services is responsible for bundling and exposing all io services, that are not part of the basic MiGrid service.
This is in addition to it also providing the OpenID authentication services, which is also not part of the basic MiGrid service.
In terms of io services, the `migrid-io` service supports the SFTP, WebDAVS, and FTPS protocols.
This service is can be used instead of the single protocol services.

Although the MiGrid Docker container contains all services, it is recommended to start multiple containers, each with as few services as possible. Eg. one container for the MiGrid webservices and one for each data transfer.
Although the shared MiGrid Docker container image contains all services, it is
recommended to start multiple separate containers, each running as few services as
possible. E.g. one container for the core MiGrid web services and one
for each of the dedicated data transfer services (SFTP, FTPS and WebDAVS).
You find an example in the docker-compose files in this repository.

:ref:`migrid <migrid_desc>`, :ref:`migrid-openid <migrid_openid_desc>`, :ref:`migrid-sftp <migrid_sftp_desc>`, :ref:`migrid-ftps <migrid_ftps_desc>`, and :ref:`migrid-webdavs <migrid_webdavs_desc>`
Expand Down
4 changes: 2 additions & 2 deletions doc/source/sections/getting-started/prerequisites.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Docker
------

Because Docker MiGrid is based on deploying the various services with Docker.
The natural implicatation is that Docker has to be installed before it can be deployed.
The natural implication is that Docker has to be installed before it can be deployed.

Depending on which operating system you are thinking of deploying Docker Migrid to,
you have to follow the Docker installation guide that is applicable to your system.
Expand Down Expand Up @@ -33,7 +33,7 @@ Docker-Swarm
of the deployed service. However, if the requirement of data processing via these services present itself, they both require that
their container services is deployed via `Docker Swarm`.

`Docker Swarm` is a multi-host orchstration framework that enables manages the health and lifetime of a particular service across a defined `Docker Swarm` cluster.
`Docker Swarm` is a multi-host orchestration framework that enables manages the health and lifetime of a particular service across a defined `Docker Swarm` cluster.

In terms of installation, the `Docker Swarm` capability is included by default in the regular `Docker` install,
so no additional steps are needed to be taken in that regard.
Expand Down
2 changes: 1 addition & 1 deletion doc/source/sections/troubleshooting/containers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ SFTP Subsystem doesn't start
This can happen due to different reasons.
Ensure that:

* Hosts keys are available and that they all have a corresponding pubkey file. Eg. `server.key` and `server.key.pub`
* Hosts keys are available and that they all have a corresponding pubkey file. E.g. `server.key` and `server.key.pub`
* If the ListenAddress is a hostname, it must be resolvable inside the container to one of its own IPs.
* No other ssh service already uses the same address e.g. because it is configured to bind on all available interfaces (`ListenAddress 0.0.0.0` or `ListenAddress ::`)

Expand Down

0 comments on commit df4c16c

Please sign in to comment.