From 805ca6cdd42de1372061b07dae334e7f610e207e Mon Sep 17 00:00:00 2001 From: Xander Harris Date: Tue, 23 Jul 2024 12:08:24 -0700 Subject: [PATCH] Update docs Closes #4 --- .github/dependabot.yml | 24 ++++++++++++++++++++++++ cicd.md | 16 +--------------- index.md | 2 +- roles/reset/tasks/main.yml | 32 ++++++++++++++++++++++---------- 4 files changed, 48 insertions(+), 26 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index bf1fe2a..720eb08 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,6 +1,30 @@ +### +# ```{rubric} Dependabot Config +# ``` +# --- +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# +# ```{note} +# Please see the documentation for all configuration +# [options](https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file). +# ``` +# +# ```{literalinclude} /.github/dependabot.yml +# :language: yaml +# :start-at: "version: 2\n" +# ``` +#f +# See documentation for possible values +# +# - `"pip"` updates: - directory: "/" package-ecosystem: "pip" + ### + # Location of package manifests + # + # - `"/"` schedule: interval: "weekly" version: 2 diff --git a/cicd.md b/cicd.md index 6b48bc5..30ddb2c 100644 --- a/cicd.md +++ b/cicd.md @@ -4,7 +4,7 @@ authors: - name: Xander Harris email: xandertheharris@gmail.com date: 2024-07-23 -title: GitHub Actions configuration +title: Continuous Integration, Delivery, and Deployment --- ## Dependabot @@ -14,20 +14,6 @@ Stay away from zero days with Dependabot. ```{autoyaml} .github/dependabot.yml ``` -````{sidebar} Dependabot Config -To get started with Dependabot version updates, you'll need to specify which -package ecosystems to update and where the package manifests are located. - -```{note} -Please see the documentation for all configuration -[options](https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file). -``` - -```{literalinclude} /.github/dependabot.yml -:language: yaml -``` -```` - ## Workflows GitHub Actions provides a pretty complete CI/CD system and they'll let you diff --git a/index.md b/index.md index c308984..27c71e9 100644 --- a/index.md +++ b/index.md @@ -5,7 +5,7 @@ authors: - name: Xander Harris email: xandertheharris@gmail.com date: 2024-03-08 -title: Ansible CA +title: Ansible Bare Metal K8S --- ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/edwardtheharris/ansible-kcp/ansible.yml?branch=main&style=flat-square&logo=ansible&label=Ansible%20Lint) diff --git a/roles/reset/tasks/main.yml b/roles/reset/tasks/main.yml index 7fd34fb..9d9120f 100644 --- a/roles/reset/tasks/main.yml +++ b/roles/reset/tasks/main.yml @@ -1,19 +1,31 @@ --- -### -# ```{rubric} Force reset an existing cluster -# ``` -# --- -# Record the output to stdout and a temporary file. -# -# ```{literalinclude} roles/reset/tasks/main.yml -# :language: yaml -# :start-at: "- name: Reset existing cluster\n" -# ``` + ### + # ```{rubric} Reset an existing cluster + # ``` + # --- + # This playbook runs `kubeadm reset -f`{l=shell} on a control plane node. + # + # ```{literalinclude} /roles/reset/tasks/main.yml + # :language: yaml + # :start-at: "- name: Reset existing cluster\n" + # :end-at: " register: reset_out\n" + # ``` - name: Reset existing cluster ansible.builtin.command: cmd: kubeadm reset -f &> /root/reset.md removes: /etc/kubernetes/admin.conf register: reset_out + ### + # ```{rubric} Show and record output + # ``` + # --- + # These tasks display the output from the command above, then write them to + # disk in a temporary location. + # + # ```{literalinclude} /roles/reset/tasks/main.yml + # :language: yaml + # :start-at: "- name: Show output\n" + # ``` - name: Show output ansible.builtin.debug: var: reset_out