Skip to content

Commit

Permalink
updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam Leiner committed Jan 28, 2025
1 parent b1ea650 commit b29f827
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 84 deletions.
92 changes: 74 additions & 18 deletions roles/rke2/defaults/main.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
rke2_kubernetes_api_server_host: ""
rke2_tarball_install_dir: "/usr/local"
rke2_install_local_tarball_path: ""
rke2_install_tarball_url: ""
rke2_images_urls: []
rke2_images_local_tarball_path: []
rke2_channel: "stable"
rke2_audit_policy_config_file_path: ""
rke2_registry_config_file_path: ""
rke2_pod_security_admission_config_file_path: ""
rke2_add_iptables_rules: false
rke2_manifest_config_directory: ""
rke2_manifest_config_post_run_directory: ""
rke2_force_tarball_install: false

# Variables shown below include their default values. Please override via groupvars as necessary.

# Installation:

## Specific version of RKE2 you wish to install. Blank defaults to latest and requires an Internet connection.
rke2_install_version: ""

## When using Internet to install RKE2, which repositories should be searched (stable or latest)
rke2_channel: "stable"

## RPM Install Specific Variables

### These two repos can point to the same 'baseurl' all of the RPMs are in the same repo.
### Common YUM repo that contains RKE2 SELinux.
rke2_common_yum_repo:
name: rancher-rke2-common
description: "Rancher RKE2 Common Latest"
Expand All @@ -22,16 +22,73 @@ rke2_common_yum_repo:
gpgkey: "https://rpm.rancher.io/public.key"
enabled: true

### Versioned YUM repo that contains RKE2 Server, Agent, and Common RPMs.
rke2_versioned_yum_repo:
name: "rancher-rke2-v{{ rke2_version_majmin }}" # noqa jinja[spacing]
description: "Rancher RKE2 Version"
baseurl: "https://rpm.rancher.io/rke2/{{ rke2_channel }}/{{ rke2_version_majmin }}/centos/$releasever/$basearch"
gpgcheck: true
gpgkey: "https://rpm.rancher.io/public.key"
enabled: true
rke2_kubelet_node_name:
- "nodeNameNotFound"
rke2_config: {}

## Tarball Install Specific Variables:

### If installing via Tarball, the location to extract the contents.
rke2_tarball_install_dir: "/usr/local"

### Path, local to Ansible control host, where the install Tarball can be found. If installing on a RPM-based OS, this will override the RPM install and force a Tarball install.
rke2_install_local_tarball_path: ""

### #URL where the install Tarball can be found. If installing on a RPM-based OS, this will override the RPM install and force a Tarball install.
rke2_install_tarball_url: ""

### RHEL-based OS's default to RPMs for installation, set to 'true' to force ansible to use a tarball. Designed for use on an Internet connected system where you want to use the Tarball available from the GitHub.

Check warning on line 45 in roles/rke2/defaults/main.yml

View workflow job for this annotation

GitHub Actions / YAML

45:201 [line-length] line too long (212 > 200 characters)
rke2_force_tarball_install: false

## Images to load directly into RKE2 via agent/images directory:

### URL of image tarball.
rke2_images_urls: []

### Path, local to Ansible control host, where an image Tarball can be found.
rke2_images_local_tarball_path: []

# Configuration:

## Defines common RKE2 config options for the whole cluster.
cluster_rke2_config: {}

Check warning on line 59 in roles/rke2/defaults/main.yml

View workflow job for this annotation

GitHub Actions / Ansible

var-naming[no-role-prefix]

Variables names from within roles should use rke2_ as a prefix. (vars: cluster_rke2_config)

## Defines common RKE2 config options for the server or agent group.
group_rke2_config: {}

Check warning on line 62 in roles/rke2/defaults/main.yml

View workflow job for this annotation

GitHub Actions / Ansible

var-naming[no-role-prefix]

Variables names from within roles should use rke2_ as a prefix. (vars: group_rke2_config)

## Defines RKE2 config options for a specific server or agent node
host_rke2_config: {}

Check warning on line 65 in roles/rke2/defaults/main.yml

View workflow job for this annotation

GitHub Actions / Ansible

var-naming[no-role-prefix]

Variables names from within roles should use rke2_ as a prefix. (vars: host_rke2_config)

## API Address for Cluster if behind Loadbalancer or Virtual IP.
rke2_kubernetes_api_server_host: ""

## Path, local to Ansible control host, where audit policy can be found.
rke2_audit_policy_config_file_path: ""

## Path, local to Ansible control host, where registries config can be found.
rke2_registry_config_file_path: ""

## Path, local to Ansible control host, where PSA policy can be found.
rke2_pod_security_admission_config_file_path: ""

## Set 'true' if Ansible should automatically add IPTABLES rules to allow for Kubernetes traffic.
rke2_add_iptables_rules: false

## Path, local to Ansible control host, where manifests can be found that will be added (to server/manifests directory) and automatically applied after first server is up.
rke2_manifest_config_directory: ""

## Path, local to Ansible control host, where manifests can be found that will be added (to server/manifests directory) and automatically applied after last server is up.
rke2_manifest_config_post_run_directory: ""

## Path, local to Ansible control host, where systemd environment file config can be found (Proxy Config).
rke2_systemd_env_config_file_path: ""

# Should not be changed:
rke2_metrics_running: false
rke2_node_ready: "false"
rke2_api_server_running: false
Expand All @@ -41,4 +98,3 @@ rke2_reboot: false
rke2_version_majmin: ""
rke2_version_rpm: ""
rke2_package_state: "installed"
rke2_systemd_env_config_file_path: ""
66 changes: 0 additions & 66 deletions roles/rke2/tasks/NOT_USED_cluster_state.yml

This file was deleted.

9 changes: 9 additions & 0 deletions terraform.tfstate
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"version": 4,
"terraform_version": "1.5.7",
"serial": 1,
"lineage": "c2c97bd2-db3d-8bef-4f3e-cd6f43b8cad5",
"outputs": {},
"resources": [],
"check_results": null
}

0 comments on commit b29f827

Please sign in to comment.