V2. MAIN. Contents refresh to newer software versions #20
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contains minor corrections done in G001 guide.
ehlesp
added
documentation
V2. G001. Refresh to newer software versions ## Update of README and chapter G001 This update makes some corrections to the introductory content of the README and G001 chapter. In particular, it reflects the fact that the reference hardware used to elaborate the guide originally is no longer available. It's also mentioned the possibility of using a virtual machine to deploy the whole setup, but taking care of making the virtualization technology of the underlying hardware available for the VM. Also, the documents get their own particular ToC to improve navigation in them.
V2. G001. Refresh to newer software versions (continuation)
V2. G002. Refresh to newer software versions ## Update of chapter G002 This update changes the Proxmox VE version to 8.4, also updating the contents and snapshots explaining the installation process to fit the newer Proxmox VE version installed. Plus, adds a note at the beginning of the G002 document, reminding that the deployment has been done in a VM rather than in the reference hardware and a ToC.
V2. G002. Refresh to newer software versions (yet more fixes) ## Update of chapter G002 (continuation) Continuation of the [previous PR for updating the G002 chapter](#23). This update includes a few changes in the details entered during the Proxmox VE installation, in particular the hostname and the example email entered associated to the root user.
V2. G003. Refresh to newer software versions ## Update of chapter G003 This update changes the Proxmox VE version to 8.4, also updating the contents and screenshots of the procedure for configuring the non-enterprise Proxmox VE repository and for updating the platform for the first time. Also adds a ToC and retouches the style of notes and titles.
V2. G004. Refresh to newer software versions ## Update of chapter G004 This update changes the NUT version to 2.8, revising the whole NUT setup procedure explained. Also adds a ToC and retouches the style of notes and titles.
V2. G005. Refresh to newer software versions ## Update of chapter G005 This updates the screenshots of the storage reorganization procedure so they are from a Proxmox VE 8.4 system, and reviews all the commands and their outputs. Also adds a ToC and retouches the style of notes and titles.
## Update of chapter G006 This update adds ToC and sections to the content, plus updates the only screenshot present. Also ensures that the procedure to disable the subscription warning still works in the Proxmox VE 8.4 system. * Adds ToC, sections, corrects title and contents, updates main index, references to file * Updates screenshot, makes corrections to content * Makes a few more corrections to content * Makes yet some more corrections to content
## Another update of chapter G009 This updates the content of the chapter G009 to apply some corrections to its texts and snippets, plus updating the ToC and ensure that all reference links work.
## Another update of chapter G010 This updates the content of the chapter G010 to make some style corrections, plus adapt to the fact that Fail2Ban no longer works with iptables but with nftables.
## Another update of chapter G011 This updates the content of the chapter G011 to refresh the configuration snippets and snapshots, while also applying some corrections and purging broken reference links.
## Another update of chapter G012 This updates the content of the chapter G012 to ensure that the sysctl-related files are the ones that really appear in the Proxmox VE 9.0 setup. Also reviews the reference links and removes broken ones.
## Another update of chapter G012 Updates the single snapshot present in the G012 chapter to make it correspond to the same Proxmox VE version shown in the other snapshots in the guide.
## Another update of chapter G013 This updates the content of the chapter G013 to reflect that the microcode package is already installed in a Proxmox VE 9.0 system.
## Another update of chapter G014 This updates the content of the chapter G014 to correct or improve the explanations regarding the Proxmox VE firewall. Also, corrects some text styling, refreshes snippets and snapshots, and updates reference links.
## Another update of chapter G015 This updates the content of the chapter G015 by adding a new "first step" section that indicates a particular step to perform before setting the sysctl configurations. Also makes some minor styling corrections, and refreshes the reference links.
## Another update of chapter G016 This reviews the content of the chapter G016 and only makes some styling corrections and very minor changes. Also applies a styling change to chapter G015 that had been forgotten in its corresponding branch.
## Another update of chapter G017 This reviews the content of the chapter G017 to update the snapshots so they correspond to Proxmox VE 9.0 plus makes some corrections in the text. Also fixes a mistake in the G014 chapter because it was related to networking (the name of the ethernet NIC was incorrect like in the G017 chapter).
## Another update of chapter G018 This update reviews the content of the chapter G018 and only makes some minor fixes to the text.
## Another update of chapter G019 This update of the chapter G019's contents changes the snapshots to fit Proxmox VE 9.0. Also corrects or adds explanations, plus it reviews the reference links.
## Update of chapter G020 Refreshes the snapshots and procedures to fit Proxmox VE 9.0 and Debian 13. In particular, in the installation process of Debian in the VM, the partition schema chosen now is the one meant `for servers`. This sets the `/var` and `/srv` directories, and the swap storage as separated partitions managed by LVM.
## Update of chapter G021 Updates the contents of the chapter G021 to ensure they fit with Debian 13 and Proxmox VE 9.0. In particular: - Adds a new intro section to the chapter G021 and to the ToC. - Reviews the procedures and corrects some configuration snippets. - Updates the snapshots. - Makes other minor corrections
## Another update of chapters G020 and G021 This update makes some corrections to the G020 chapter and an addition to the G021 chapter: - In the chapter G020, changes the partition scheme chosen in the installation procedure to the default simple one. Then the snapshots and the affected steps are also adapted to this change. - In the chapter G021, adds a procedure to remove the microcode package that the installer autoinstalls in the VM. - Also makes some minor corrections in both chapters
## Update of chapter G022 Updates the contents of the chapter G022 to ensure they fit with Debian 13, Proxmox VE 9.0 and NUT 2.8.1: - Adds a new intro section to the chapter G022 and to the ToC. - Reviews the NUT procedures, and corrects some configuration snippets. - Removes deprecated mentions of `master` and `slave` systems, replacing them with `primary` and `secondary`. - Updates all the snapshots. - Makes other minor corrections
## Update of chapter G023 Updates the chapter G023 to ensure it fits with Proxmox VE 9.0: - Adds a ToC. - Adds a proper intro section to the chapter G023. - Refreshes the whole VM template procedure, also the backup and restore one. - Updates all the snapshots. - Makes other minor corrections
## Update of chapter G024 Updates the chapter G024 to ensure it fits with Proxmox VE 9.0 and Debian 13: - Adds a ToC. - Gives a title to the intro section. - Reviews and corrects where necessary the procedures. - Updates all the snapshots. - Makes other minor corrections to the texts.
## Update of chapter G025 Updates the chapter G025 to ensure it fits with Proxmox VE 9.0 and K3s v1.33.4+k3s1: - Adds a ToC to the chapter. - Gives a title to the intro section. - Corrects some section titles. - Reviews and corrects the procedures where necessary. - Changes the section about the K3s logs. - Updates all the snapshots. - Makes other minor corrections to the texts. - In the chapter G024, corrects the hostname specified for the K3s node template. * Fixes small mistake in sentence
## Update of chapter G026 Updates the chapter G026 to make it fit to the quirks of K3s v1.33.4+k3s1: - Adds a ToC to the chapter. - Gives a title to the intro section. - Corrects a couple of section titles. - Reviews and corrects the procedures where necessary. - Explains the fix to add the external IP of the server node to the autogenerated certificate of the cluster. - Replaces the deprecated `kubeval` tool with `kubeconform`. - Updates the single snapshot. - Makes other corrections to the texts.
## Another update of chapter G026 Updates the chapter G026 to add a note reminding about the possibility of further narrowing the access to the K3s cluster's port `6443` just to a specific set of IPs which have to be static. Also applies a few corrections.
…LC cert (#72) ## Correction of chapters G025 and G026 Corrects an issue with the external IP of the K3s server node. It is necessary for it to be specified also in the tls-san option of the server node configuration. Otherwise, is rejected by the autogenerated certificate when trying to connect with the `kubectl` client through that external IP. This has implied doing fixes both in the chapter G025 and G026. Also fixes the use of the "guide" term and other mistakes.
## Update of chapter G027 Updates the chapter G027 to make it work with MetalLB v0.15.2: - Adds a ToC to the chapter. - Gives a title to the intro section. - Updates MetalLB deployment procedure to use the modern approach (not using configmap). - Removes the no longer needed appendix chapter that explained the modern approach for deploying MetalLB. - Adjusts main ToC and other appendix chapters to the removal of the G912 one. - Updates code/config snippets. - Updates Kustomize project for MetalLB deployment. - Prunes ref links.
## Update of chapter G028 Updates the chapter G028 to make it work with metrics-server v0.8.0: - Adds a ToC to the chapter. - Gives a title to the intro section. - Updates metrics-server deployment procedure to use the proper Kustomize patching method with `patches` section. - Updates code/config snippets. - Updates Kustomize project for metrics-server deployment. - Prunes ref links.
## Update of chapter G029 Overhaul of the chapter G029: - Renames the chapter's file. - Adds a ToC to the chapter. - Gives a title to the intro section. - Updates the cert-manager deployment procedure so the service uses the `certificates` namespace. - Replaces the setup of a wildcard certificate with a more proper self-signed CA. - Updates code and YAML snippets. - Updates Kustomize project for cert-manager deployment. - Updates Kustomize project for deploying the self-signed CA. - Removes Refactor deployment and related Kustomize project since it is no longer needed in the new setup. - Prunes ref links.
## Update of chapter G030 Overhaul of the chapter G030, where the Kubernetes Dashboard is replaced by Headlamp because K8s' dashboard no longer supports installation by `kubectl`: - Renames the chapter's file. - Adds a ToC to the chapter. - Gives a title to the intro section. - Adapts the whole deployment procedure to Headlamp. - Updates code and YAML snippets. - Creates a new Headlamp Kustomize project. - Removes Kubernetes Dashboard deployment and related Kustomize project since it is no longer needed in the new setup. - Prunes ref links.
## Review of Kustomize projects of chapters G027 to G030 Reviews and fixes some issues in the chapters G027, G028, G029 and G030 related to the Kustomize projects: - Mainly, this review is about fixing some file names to make them consistent across all Kustomize projects. - This update also changes the modified file names in the corresponding procedures. - Adds missing links pointing to related Kustomize projects in some chapters. - Fixes some other issues found in the chapters' contents. * Adds missing links to Kustomize projects in chapters G027 and G028
## Correction of chapter G029 In a previous version, I had customized the default namespace where cert-manage would look up for certificates in the cluster. Later, I discovered that this was not really necessary when using cluster issuers so I decided to simplify the cert-manager setup and leave it with its original default configuration. Also, I've taken the chance to standardize better the names used in the certificates and use the `-tls` suffix rather than `-crt`. All these considerations have implied the following changes: - Simplification of the Kustomize deployment of cert-manager by removing any setup related to change the default namespace for certificates. - Renaming of the CA certificates to use the `-tls` suffix, which also implied renaming the corresponding YAML files. - Removal of an entire section about cert-manager performance in deployment, mainly because I didn't had the issue this time. - Bumping up of cert-manager version used to v1.19.0. - Several other corrections in the chapter G029, mainly in the procedures's steps and in the shell snippets.
## Update of chapter G031 Reordering of the chapters G030 and G031 and revision of the Traefik dashboard enabling process. Now, enabling the Traefik dashboard goes before deploying Headlamp: - The chapter G030 is now the one about Traefik dashboard, and G031 is about Headlamp. - Adds a ToC to the Traefik chapter. - Gives a title to the intro section. - Reviews and corrects the process for enabling the Traefik dashboard. - Updates code and YAML snippets. - Updates the Traefik dashboard Kustomize project. - Prunes ref links.
## Update of chapter G032 This update mainly corrects the text in chapter G032, but also: - Adds a ToC to the chapter. - Gives a title to the intro section. - Updates main ToC
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refresh of the software versions used in this guide
This update just applies the necessary changes to update the software versions used in this guide.
The changes will mainly imply updating snapshots, code snippets and mentions of the software versions used. Still, more profound changes might be required in some cases. Also, doing some other minor improvements can be considered like adding ToCs to each chapter or improving the styling of notes. These minor updates should neither require much effort to do nor disrupt this project's contents.
THIS PR IS NOT FOR COMMITING CHANGES DIRECTLY
Except for the opening initial commit, ALL CHANGES put into the
v2-mainbranch must come from subbranches. This allows for having focused independent discussions on the changes done on each chapter.Each modified chapter must be updated in its own
v2-mainderived branch, then merged into v2-master from their corresponding PR.The naming schema to use with all subbranches is
v2-G###-sw-version-refresh, where the###is the placeholder for the number of the guide chapter being updated.Also, the title of the corresponding PRs should be minimally consistent with each other. Something like
V2. G###. Refresh to newer software versionswould suffice.The appendixes are not a focus of this refresh
The focus of this PR is on updating the main chapters, NOT the appendixes.
Although interesting and useful in their own right, the appendixes they're more like notes left as reminders of other possibilities or details to be aware of.