diff --git a/bootstrap/vars/addons.sample.yaml b/bootstrap/vars/addons.sample.yaml index 9bc7a9b2..b18f0450 100644 --- a/bootstrap/vars/addons.sample.yaml +++ b/bootstrap/vars/addons.sample.yaml @@ -10,7 +10,7 @@ addon_homepage: # https://github.com/grafana/grafana addon_grafana: enabled: false - # password: # password for `admin` user + # password: # Required: password for `admin` user # https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack addon_kube_prometheus_stack: @@ -19,13 +19,44 @@ addon_kube_prometheus_stack: # https://github.com/kubernetes/dashboard addon_kubernetes_dashboard: enabled: false - # Password can be obtained by running the following command once it is deployed: - # kubectl -n monitoring get secret kubernetes-dashboard -o jsonpath='{.data.token}' | base64 -d + # NOTE: Password can be obtained by running the following command once it is deployed: + # kubectl -n monitoring get secret kubernetes-dashboard -o jsonpath='{.data.token}' | base64 -d # https://github.com/weaveworks/weave-gitops addon_weave_gitops: enabled: false - # password: # password for `admin` user + # password: # Required: password for `admin` user + +# https://github.com/rancher/system-upgrade-controller +addon_system_upgrade_controller: + # IMPORTANT: Only enable this if you also track the version of k3s in the + # ansible configuration files. Running ansible against an already provisioned + # cluster with this enabled might cause your cluster to be downgraded. + # NOTE: If bootstrap_distribution is set to k0s or talos this will be ignored. + enabled: false + +# https://github.com/morphy2k/rss-forwarder +addon_discord_template_notifier: + # Will post commits from the template repository to the specified discord channel + # so it's easier to keep track of changes. + enabled: false + # webhook_url: # Required: Discord webhook url + +# https://github.com/backube/volsync +addon_volsync: + enabled: false + +# https://github.com/longhorn/longhorn +addon_longhorn: + # IMPORTANT: Only enable this if you have 3 or more nodes in your cluster + # and you have enough IOPS on disk to support the number of replicas. + # NOTE: Longhorn is currently unsupported in Talos, this will be ignored + # if you are using Talos. + # NOTE: Consider enabling volsync if you would like to configure snapshots + # and backups to durable storage. + # NOTE: You must label any node that you want to allocate storage to longhorn + # e.g. kubectl label --overwrite node node.longhorn.io/create-default-disk="true" + enabled: false # https://github.com/kubernetes-csi/csi-driver-nfs addon_csi_driver_nfs: @@ -41,45 +72,14 @@ addon_csi_driver_smb: enabled: false create_secrets: true # set to false to disable secret template rendering storage_class: - # - name: # name of the storage class (must match [a-z0-9-]+) - # source: # network path of the smb share ie: //192.168.0.5/downloads - # username: # share credentials - # password: # share credentials - # dir_mode: # default 0777 - # file_mode: # default 0666 - # uid: # default 1000 - # gid: # default 1000 - # secret_name: # default {name}-secret - # secret_namespace: # default storage + # - name: # name of the storage class (must match [a-z0-9-]+) + # source: # network path of the smb share e.g. //192.168.0.5/downloads + # username: # share credentials + # password: # share credentials + # dir_mode: # default 0777 + # file_mode: # default 0666 + # uid: # default 1000 + # gid: # default 1000 + # secret_name: # default "{name}-secret" + # secret_namespace: # default "storage" # ... - -# https://github.com/rancher/system-upgrade-controller -addon_system_upgrade_controller: - # IMPORTANT: Only enable this if you also track the version of k3s in the - # ansible configuration files. Running ansible against an already provisioned - # cluster with this enabled might cause your cluster to be downgraded. - # Note: If bootstrap_distribution is set to k0s or talos this will be ignored. - enabled: false - -# https://github.com/morphy2k/rss-forwarder -addon_discord_template_notifier: - # Will post commits from the template repository to the specified discord channel - # so it's easier to keep track of changes. - enabled: false - webhook_url: # Discord webhook url - -# https://github.com/backube/volsync -addon_volsync: - enabled: false - -# https://github.com/longhorn/longhorn -addon_longhorn: - # IMPORTANT: Only enable this if you have 3 or more nodes in your cluster - # and you have enough IOPS on disk to support the number of replicas. - # Longhorn is currently unsupported in Talos - # NOTE: Consider enabling volsync if you would like to configure snapshots - # and backups to durable storage. - # NOTE: You must label any node that you want to allocate storage to longhorn - # with label node.longhorn.io/create-default-disk="true" - # ie: kubectl label --overwrite node node.longhorn.io/create-default-disk="true" - enabled: false diff --git a/bootstrap/vars/config.sample.yaml b/bootstrap/vars/config.sample.yaml index f964af81..e104f69c 100644 --- a/bootstrap/vars/config.sample.yaml +++ b/bootstrap/vars/config.sample.yaml @@ -14,13 +14,12 @@ bootstrap_github_repository_name: bootstrap_age_public_key: # Choose your timezone (e.g. America/New_York) bootstrap_timezone: Etc/UTC -# Email you want to be associated with the ACME account (used for TLS certificates via letsencrypt.org) +# Email you want to be associated with the ACME account (used for TLS certs via letsencrypt.org) bootstrap_acme_email: -# Use the ACME production env when requesting the wildcard certificate, -# the default here is `false` which means ACME staging env will be used instead. -# This is to prevent being rate-limited. Update this option to `true` when you -# have verified the staging certificate works and then re-run `task configure` -# and push your changes to Github. +# Use the ACME production env when requesting the wildcard certificate. +# By default the ACME staging server is used. This is to prevent being rate-limited. +# Update this option to `true` when you have verified the staging certificate +# works and then re-run `task configure` and push your changes to Github. bootstrap_acme_production_enabled: false # Flux github webhook token (openssl rand -hex 12) @@ -28,7 +27,7 @@ bootstrap_flux_github_webhook_token: # Cloudflare domain bootstrap_cloudflare_domain: -# Cloudflare API Token (not API Key) +# Cloudflare API Token (NOT API Key) bootstrap_cloudflare_token: # Cloudflared Account Tag (cat ~/.cloudflared/*.json | jq -r .AccountTag) bootstrap_cloudflare_account_tag: @@ -40,16 +39,21 @@ bootstrap_cloudflare_tunnel_id: # CIDR your nodes are on (e.g. 192.168.1.0/24) bootstrap_node_cidr: -# The IP address of the Kube API, choose an available IP in your nodes network that is not being used. This is announced over L2. +# The IP address of the Kube API, choose an available IP in your nodes +# network that is NOT being used. This is announced over L2. bootstrap_kube_api_addr: -# The Load balancer IP for k8s_gateway, choose an available IP in your nodes network that is not being used. This is announced over L2. +# The Load balancer IP for k8s_gateway, choose an available IP in your nodes +# network that is NOT being used. This is announced over L2. bootstrap_k8s_gateway_addr: -# The Load balancer IP for external ingress, choose an available IP in your nodes network that is not being used. This is announced over L2. +# The Load balancer IP for external ingress, choose an available IP in your nodes +# network that is NOT being used. This is announced over L2. bootstrap_external_ingress_addr: -# The Load balancer IP for internal ingress, choose an available IP in your nodes network that is not being used. This is announced over L2. +# The Load balancer IP for internal ingress, choose an available IP in your nodes +# network that is NOT being used. This is announced over L2. bootstrap_internal_ingress_addr: -# Add additional SANs to the Kube API cert, this is useful if you want to call the Kube API by hostname rather than IP +# Add additional SANs to the Kube API cert, this is useful if you want +# to call the Kube API by hostname rather than IP bootstrap_kube_additional_tls_sans: [] # The DNS server to use for the cluster, this can be an existing local DNS server or a public one @@ -59,11 +63,11 @@ bootstrap_kube_additional_tls_sans: [] # 3. you are not force redirecting DNS requests to it - this will break cert generation over DNS01 bootstrap_dns_server: 1.1.1.1 -# The pod CIDR for the cluster, this must not overlap with any existing networks -# If you want to use IPv6 check the advanced flags below +# The pod CIDR for the cluster, this must NOT overlap with any existing networks +# If you want to use IPv6 check the advanced flags below bootstrap_cluster_cidr: 10.42.0.0/16 -# The service CIDR for the cluster, this must not overlap with any existing networks -# If you want to use IPv6 check the advanced flags below +# The service CIDR for the cluster, this must NOT overlap with any existing networks +# If you want to use IPv6 check the advanced flags below bootstrap_service_cidr: 10.43.0.0/16 # Node information @@ -75,7 +79,7 @@ bootstrap_nodes: # username: # ssh username of the master node # diskSerial: # (Required: Talos) Serial number of Disk for this master node # ... - worker: # set to [] or omit if no workers are needed + worker: # set to [] or omit if no workers are needed # - name: # name or hostname of the worker node (must match [a-z0-9-\.]+) # address: # ip address of the worker node # username: # ssh username of the worker node @@ -88,17 +92,21 @@ bootstrap_nodes: # # bootstrap_advanced_flags: -# # Github repository branch +# # Change the default Github repository branch # github_repository_branch: main +# # # Disable to prevent changes to nodes /etc/resolv.conf # update_resolv_conf: true +# # # Cilium load balancer mode, choose either 'dsr' or 'snat' # # Due to unknown reasons some people need this set to 'snat' in order # # for Cilium L2 announcements to work properly. Keep this dsr unless # # you have issues with connecting to Cilium L2 announcements. # cilium_loadbalancer_mode: dsr +# # # Path for openebs openebs-hostpath to use for storage on ALL nodes # local_storage_path: /var/openebs/local +# # # Enable Dual Stack IPv4 first # # IMPORTANT: I am looking for people to help maintain IPv6 support since I cannot test it. # # https://github.com/onedr0p/flux-cluster-template/issues/1148