diff --git a/knowledge base/README.md b/knowledge base/README.md index 83db10b..f4d469a 100644 --- a/knowledge base/README.md +++ b/knowledge base/README.md @@ -19,6 +19,9 @@ This is the collection of all notes, reminders and whatnot I gathered during the #!/usr/bin/env zsh ``` +- Prefer **GitHub**'s markdown flavour where multiple are available.
+ Just because GitHub seems to be the place most people will look at this repository. + - Group related options in commands where possible.
It gives enhanced clarity and a sense of continuation. diff --git a/knowledge base/awx.md b/knowledge base/awx.md index f1e8003..ceee86f 100644 --- a/knowledge base/awx.md +++ b/knowledge base/awx.md @@ -1,12 +1,13 @@ # Ansible AWX 1. [Gotchas](#gotchas) -1. [Instance setup](#instance-setup) +1. [Setup](#setup) 1. [Deployment](#deployment) 1. [Update](#update) 1. [Removal](#removal) 1. [Testing](#testing) -1. [Jobs execution](#jobs-execution) + 1. [Job execution](#job-execution) +1. [Job templates](#job-templates) 1. [Workflow automation](#workflow-automation) 1. [Pass data between workflow nodes](#pass-data-between-workflow-nodes) 1. [API](#api) @@ -84,7 +85,7 @@ -## Instance setup +## Setup ### Deployment @@ -592,8 +593,7 @@ $ minikube kubectl -- delete ns 'awx'
Run: kustomized helm chart -> #### Warning -> +> [!warning] > Remember to include the CRDs from the helm chart.
@@ -754,7 +754,7 @@ deployment.apps "awx-operator-controller-manager" deleted
-## Jobs execution +### Job execution Unless explicitly defined in Job Templates or Schedules, Jobs using a containerized execution environment are executed by the _default_ container group. @@ -888,6 +888,20 @@ resource limits. +## Job templates + +> [!warning] +> Variables configured in job templates are given to the `ansible-playbook` command for the job using its +> `-e, --extra-vars` option.
+> This means they will have the **highest** precedence of all variables, and as such they will override **any** other +> block or task variable named like that. Refer [Ansible variables]. + +> [!caution] +> Once a variable is defined in a job template, it **will** be passed to the ansible command for the job.
+> When launching a job that allows for variables editing, the edited ones will be **merged** with the initial setting. +> As such, deleting variables while launching a job will result in them still being passed on with the value they had in +> the initial variables setting. + ## Workflow automation Refer [How to use workflow job templates in Ansible], [Workflow job templates] and [Workflows].
@@ -1085,9 +1099,11 @@ Refer [AWX Command Line Interface] for more information. ═╬═Time══ --> + [gotchas]: #gotchas +[Ansible variables]: ansible.md#variables [helm]: kubernetes/helm.md [kubernetes]: kubernetes/README.md [kustomize]: kubernetes/kustomize.md diff --git a/knowledge base/markdown.md b/knowledge base/markdown.md index a7f741d..81a867e 100644 --- a/knowledge base/markdown.md +++ b/knowledge base/markdown.md @@ -5,6 +5,8 @@ ReadMe's Markdown engine. Compare Markdown implementations at [babelmark]. 1. [TL;DR](#tldr) +1. [Alerts](#alerts) +1. [Images](#images) 1. [Troubleshooting](#troubleshooting) 1. [Escape the backtick character](#escape-the-backtick-character) 1. [Render mermaid.js graphs in VS Code's Markdown preview](#render-mermaidjs-graphs-in-vs-codes-markdown-preview) @@ -13,57 +15,6 @@ Compare Markdown implementations at [babelmark]. ## TL;DR -
- Alerts - -Requires the Alert extension. - -Refer [Github's alert formatting][github formatting alerts]. - -```md -> [!NOTE] -> Useful information that users should know, even when skimming content. - -> [!TIP] -> Helpful advice for doing things better or more easily. - -> [!IMPORTANT] -> Key information users need to know to achieve their goal. - -> [!WARNING] -> Urgent info that needs immediate user attention to avoid problems. - -> [!CAUTION] -> Advises about risks or negative outcomes of certain actions. -``` - ---- - -> [!NOTE] -> Useful information that users should know, even when skimming content. - ---- - -> [!TIP] -> Helpful advice for doing things better or more easily. - ---- - -> [!IMPORTANT] -> Key information users need to know to achieve their goal. - ---- - -> [!WARNING] -> Urgent info that needs immediate user attention to avoid problems. - ---- - -> [!CAUTION] -> Advises about risks or negative outcomes of certain actions. - -
-
Diagrams @@ -87,30 +38,6 @@ Use a `
` HTML tag:
-
- Include images - -Add an image: - -```md -![description](path/to.image) -![description][reference name] -``` - -Control width and height: - -```md - -``` - -Align in the center: - -```md -
![sleep-cat](./cat.png)
-``` - -
-
Math @@ -149,6 +76,9 @@ private void index(){ } ``` +Refer [Syntax highlighting in markdown] and [linguist supported language syntax list] for recognized languages and their +aliases. +
@@ -165,6 +95,130 @@ checked one.
+## Alerts + +Alerts are not defined in the base Markdown specification.
+They are extensions that the most famous flavours introduced or adopted, each with small but annoying differences. + +
+ GitHub formatting + +Refer [GitHub's alert formatting][github formatting alerts]. + +```md +> [!NOTE] +> Useful information that users should know, even when skimming content. + +> [!TIP] +> Helpful advice for doing things better or more easily. + +> [!IMPORTANT] +> Key information users need to know to achieve their goal. + +> [!WARNING] +> Urgent info that needs immediate user attention to avoid problems. + +> [!CAUTION] +> Advises about risks or negative outcomes of certain actions. +``` + +--- + +> [!NOTE] +> Useful information that users should know, even when skimming content. + +--- + +> [!TIP] +> Helpful advice for doing things better or more easily. + +--- + +> [!IMPORTANT] +> Key information users need to know to achieve their goal. + +--- + +> [!WARNING] +> Urgent info that needs immediate user attention to avoid problems. + +--- + +> [!CAUTION] +> Advises about risks or negative outcomes of certain actions. + +
+ +
+ GitLab formatting + +Refer [GitLab Flavored Markdown][gitlab flavored markdown alerts]. + +```md +> [!note] +> Information that users should take into account, even when skimming. + +> [!tip] +> Optional information to help a user be more successful. + +> [!important] +> Crucial information necessary for users to succeed. + +> [!caution] +> Negative potential consequences of an action. + +> [!warning] +> Critical potential risks. +``` + +--- + +> [!note] +> Information that users should take into account, even when skimming. + +--- + +> [!tip] +> Optional information to help a user be more successful. + +--- + +> [!important] +> Crucial information necessary for users to succeed. + +--- + +> [!caution] +> Negative potential consequences of an action. + +--- + +> [!warning] +> Critical potential risks. + +
+ +## Images + +Add an image: + +```md +![description](path/to.image) +![description][reference name] +``` + +Control width and height: + +```md + +``` + +Align in the center: + +```md +
![sleep-cat](./cat.png)
+``` + ## Troubleshooting ### Escape the backtick character @@ -199,6 +253,8 @@ Install and enable [`bierner.markdown-mermaid`][bierner.markdown-mermaid]'s exte - [The magical Markdown I bet you don't know] - [slaise/High-level-Markdown] - [Syntax highlighting in Markdown] +- [Writing on GitHub] +- [GitLab Flavored Markdown]