From 5a139f3707221db5922e2420fc6b3ca60a40dbab Mon Sep 17 00:00:00 2001 From: Jon Date: Sun, 12 Nov 2023 18:26:26 +0930 Subject: [PATCH] docs: added initial doc page and add template repo ready for deployment !1 nofusscomputing/infrastructure/website!38 --- .gitmodules | 3 ++ .vscode/extensions.json | 3 +- docs/articles/index.md | 0 docs/contact.md | 0 docs/index.md | 0 docs/operations/index.md | 0 docs/projects/docker/bind/index.md | 56 +++++++++++++++++++ docs/projects/docker/index.md | 0 docs/projects/index.md | 0 docs/tags.md | 0 docs/task-doc-template.md | 87 ++++++++++++++++++++++++++++++ mkdocs.yml | 30 +++++++++++ website-template | 1 + 13 files changed, 179 insertions(+), 1 deletion(-) create mode 100644 docs/articles/index.md create mode 100644 docs/contact.md create mode 100644 docs/index.md create mode 100644 docs/operations/index.md create mode 100644 docs/projects/docker/bind/index.md create mode 100644 docs/projects/docker/index.md create mode 100644 docs/projects/index.md create mode 100644 docs/tags.md create mode 100644 docs/task-doc-template.md create mode 100644 mkdocs.yml create mode 160000 website-template diff --git a/.gitmodules b/.gitmodules index cc4d8a5..36b1871 100644 --- a/.gitmodules +++ b/.gitmodules @@ -2,3 +2,6 @@ path = gitlab-ci url = https://gitlab.com/nofusscomputing/projects/gitlab-ci.git branch = development +[submodule "website-template"] + path = website-template + url = https://gitlab.com/nofusscomputing/infrastructure/website-template.git diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 486c2c2..563ec37 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -4,6 +4,7 @@ "ms-azuretools.vscode-docker", "gitlab.gitlab-workflow", "ms-kubernetes-tools.vscode-kubernetes-tools", - "redhat.vscode-yaml" + "redhat.vscode-yaml", + "jebbs.markdown-extended" ] } \ No newline at end of file diff --git a/docs/articles/index.md b/docs/articles/index.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/contact.md b/docs/contact.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/operations/index.md b/docs/operations/index.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/projects/docker/bind/index.md b/docs/projects/docker/bind/index.md new file mode 100644 index 0000000..e4106b6 --- /dev/null +++ b/docs/projects/docker/bind/index.md @@ -0,0 +1,56 @@ +--- +title: Dockerized Bind DNS Server +description: How to use No Fuss Computings docker container bind. +date: 2023-11-12 +template: project.html +about: https://gitlab.com/nofusscomputing/projects/docker-bind +--- + +This docker container is for running the BIND9 DNS Server from within a container environment. Usage of the Alpine Linux image for the base was chosen to limit container size. Inclusive of bind9, `supervisord` is the entry point which starts bind9. As supervisor daemon is used, a health check has been setup and automagically runs and if any service fails, the health check will adjust accordingly. + + +## Configuration + +All Configuration for Bind is located in directory `/etc/bind/` when launching this container it's recommended that this path be a volume and you place your own config files there. Without doing so the container will start a DNS server that will only accept connections from `127.0.0.1` + +!!! info + Bind9 Documentation can be found at + + +## Running the container + +To quickly setup a container the following `docker-compose.yaml` file could be used. + +``` yaml title="docker-compose.yaml" linenums="1" + +services: + + bind: + image: nofusscomputing/docker-bind:dev + container_name : bind + hostname: bind + ports: + - "53:53" + volumes: + - data_bind9:/etc/bind + # - logs_bind9:/var/logs + environment: + - TIMEZONE=UTC + restart: always + networks: + - default + - ingress + + +volumes: + data_bind9: + # logs_bind9: + + +networks: + default: + external: no + ingress: + external: yes + +``` diff --git a/docs/projects/docker/index.md b/docs/projects/docker/index.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/projects/index.md b/docs/projects/index.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/tags.md b/docs/tags.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/task-doc-template.md b/docs/task-doc-template.md new file mode 100644 index 0000000..ade9fcd --- /dev/null +++ b/docs/task-doc-template.md @@ -0,0 +1,87 @@ + + +short summary of the task file + +## {Task Name} + +- **Name**: + +- **Description**: + +- **Module**: + +- **Arguments**: + + - + +- **Conditional**: + +- **Tags**: + + - + +## {Task Name} + +- **Name**: + +- **Description**: + +- **Module**: + +- **Arguments**: + + - + +- **Registers**: + +- **Conditional**: + +- **Tags**: + + - + + +## Variables + +The following variables can be customized in this task file: + +```yaml +variable_name: "default_value" +``` + +- `variable_name`: Description of the variable. + +## Tags + +The tasks in this task file are tagged with the following tags: + +- + +## Usage + +To use this Ansible task file, you can include it in your playbook or role and provide values for the required variables. Here's an example of how you can use this task file: + +1. Create a playbook (e.g., `your_playbook.yaml`) and define the necessary variables: + +```yaml +--- + +- hosts: your_hosts + vars: + variable_name: "value" + + tasks: + - include_tasks: path/to/task_file.yaml +``` + +2. Create a separate file for the task file (e.g., `task_file.yaml`) and copy the content of the task file into it. + +3. Run the playbook: + +```shell +ansible-playbook your_playbook.yaml +``` + +Make sure to replace the placeholder values (`variable_name`, `value`) with the appropriate values for your setup. + +Note: You may need to adjust the playbook structure and additional tasks based on your specific requirements and the tasks you want to execute. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..f152865 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,30 @@ +INHERIT: website-template/mkdocs.yml + +docs_dir: 'docs' + +repo_name: Docker Bind +repo_url: https://gitlab.com/nofusscomputing/projects/docker-glpi +edit_uri: '/-/ide/project/nofusscomputing/projects/docker-bind/edit/development/-/docs/' + +nav: +- Home: index.md + +- Articles: + + - articles/index.md + +- Projects: + + - projects/index.md + + - GLPI Docker: + + - projects/docker/bind/index.md + + +- Operations: + + - operations/index.md + +- Contact Us: contact.md + diff --git a/website-template b/website-template new file mode 160000 index 0000000..992b548 --- /dev/null +++ b/website-template @@ -0,0 +1 @@ +Subproject commit 992b54805b8b6c78a3d2a5ea7de71c7be2b070c8