From df126a576d6fb81ae7c4caa07154502b5d119f0f Mon Sep 17 00:00:00 2001 From: Jon Date: Tue, 19 Sep 2023 14:58:46 +0930 Subject: [PATCH] feat: initial template, docs and ci !1 --- .cz.yaml | 7 ++ .gitlab-ci.yml | 35 ++++++++ .gitmodules | 8 ++ .helmignore | 23 ++++++ README.md | 4 + docs/articles/index.md | 0 docs/contact.md | 0 docs/index.md | 0 docs/operations/index.md | 0 docs/projects/index.md | 0 docs/projects/kubernetes_monitoring/index.md | 18 ++++ docs/tags.md | 0 docs/task-doc-template.md | 87 ++++++++++++++++++++ gitlab-ci | 1 + mkdocs.yml | 30 +++++++ website-template | 1 + 16 files changed, 214 insertions(+) create mode 100644 .cz.yaml create mode 100644 .gitlab-ci.yml create mode 100644 .gitmodules create mode 100644 .helmignore 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/index.md create mode 100644 docs/projects/kubernetes_monitoring/index.md create mode 100644 docs/tags.md create mode 100644 docs/task-doc-template.md create mode 160000 gitlab-ci create mode 100644 mkdocs.yml create mode 160000 website-template diff --git a/.cz.yaml b/.cz.yaml new file mode 100644 index 0000000..62b2ada --- /dev/null +++ b/.cz.yaml @@ -0,0 +1,7 @@ +commitizen: + bump_message: "build(version): bump version $current_version \u2192 $new_version" + changelog_incremental: false + name: cz_conventional_commits + tag_format: $major.$minor.$patch$prerelease + update_changelog_on_bump: true + version: 0.0.1 diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..a596569 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,35 @@ +variables: + MY_PROJECT_ID: "50510268" + GIT_SYNC_URL: "https://$GITHUB_USERNAME_ROBOT:$GITHUB_TOKEN_ROBOT@github.com/NoFussComputing/docker-glpi.git" + + + PAGES_ENVIRONMENT_PATH: projects/kubernetes_monitoring/ + +include: + - project: nofusscomputing/projects/gitlab-ci + ref: development + file: + - template/automagic.gitlab-ci.yaml + #- template: Jobs/Container-Scanning.gitlab-ci.yml # see https://gitlab.com/gitlab-org/gitlab/-/issues/381665 + + +Website.Submodule.Deploy: + extends: .submodule_update_trigger + variables: + SUBMODULE_UPDATE_TRIGGER_PROJECT: nofusscomputing/infrastructure/website + environment: + url: https://nofusscomputing.com/$PAGES_ENVIRONMENT_PATH + name: Documentation + rules: + - if: # condition_dev_branch_push + $CI_COMMIT_BRANCH == "development" && + $CI_PIPELINE_SOURCE == "push" + exists: + - '{docs/**,pages/**}/*.md' + changes: + paths: + - '{docs/**,pages/**}/*.md' + compare_to: 'master' + when: always + + - when: never diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..de6bfdd --- /dev/null +++ b/.gitmodules @@ -0,0 +1,8 @@ +[submodule "gitlab-ci"] + 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 + branch = development diff --git a/.helmignore b/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/README.md b/README.md index 0732e82..cb9ad14 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,10 @@ All contributions for this project must conducted from [Gitlab](https://gitlab.c For further details on contributing please refer to the [contribution guide](CONTRIBUTING.md). +## Documentation + +Documentation for this project can be found at + ## Other This repo is release under this [license](LICENSE) 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/index.md b/docs/projects/index.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/projects/kubernetes_monitoring/index.md b/docs/projects/kubernetes_monitoring/index.md new file mode 100644 index 0000000..f7f07fc --- /dev/null +++ b/docs/projects/kubernetes_monitoring/index.md @@ -0,0 +1,18 @@ +--- +title: Kubernetes Monitoring Helm Chart +description: How to use No Fuss Computings kubernetes monitoring helm chart for full stack monitoring. +date: 2023-08-29 +template: project.html +about: https://gitlab.com/nofusscomputing/projects/kubernetes_monitoring +--- + + +## Running the container + +To quickly setup a container the following `docker-compose.yaml` file could be used. + +``` yaml title="docker-compose.yaml" linenums="1" + + + +``` 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/gitlab-ci b/gitlab-ci new file mode 160000 index 0000000..a5a9fa4 --- /dev/null +++ b/gitlab-ci @@ -0,0 +1 @@ +Subproject commit a5a9fa44374107657b2587ce52607d96a825be56 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..355d4fb --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,30 @@ +INHERIT: website-template/mkdocs.yml + +docs_dir: 'docs' + +repo_name: Kubernetes Monitoring Helm Chart +repo_url: https://gitlab.com/nofusscomputing/projects/kubernetes_monitoring +edit_uri: '/-/ide/project/nofusscomputing/projects/kubernetes_monitoring/edit/development/-/docs/' + +nav: +- Home: index.md + +- Articles: + + - articles/index.md + +- Projects: + + - projects/index.md + + - Kubernetes Monitoring: + + - projects/kubernetes_monitoring/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