docs: added initial doc page and add template repo ready for deployment

!1 nofusscomputing/infrastructure/website!38
This commit is contained in:
2023-11-12 18:26:26 +09:30
parent a6db664527
commit 5a139f3707
13 changed files with 179 additions and 1 deletions

3
.gitmodules vendored
View File

@ -2,3 +2,6 @@
path = gitlab-ci path = gitlab-ci
url = https://gitlab.com/nofusscomputing/projects/gitlab-ci.git url = https://gitlab.com/nofusscomputing/projects/gitlab-ci.git
branch = development branch = development
[submodule "website-template"]
path = website-template
url = https://gitlab.com/nofusscomputing/infrastructure/website-template.git

View File

@ -4,6 +4,7 @@
"ms-azuretools.vscode-docker", "ms-azuretools.vscode-docker",
"gitlab.gitlab-workflow", "gitlab.gitlab-workflow",
"ms-kubernetes-tools.vscode-kubernetes-tools", "ms-kubernetes-tools.vscode-kubernetes-tools",
"redhat.vscode-yaml" "redhat.vscode-yaml",
"jebbs.markdown-extended"
] ]
} }

0
docs/articles/index.md Normal file
View File

0
docs/contact.md Normal file
View File

0
docs/index.md Normal file
View File

0
docs/operations/index.md Normal file
View File

View File

@ -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 <https://bind9.readthedocs.io/en/v9.18.19/reference.html>
## 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
```

View File

0
docs/projects/index.md Normal file
View File

0
docs/tags.md Normal file
View File

87
docs/task-doc-template.md Normal file
View File

@ -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.

30
mkdocs.yml Normal file
View File

@ -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

1
website-template Submodule

Submodule website-template added at 992b54805b