From ad1d09f43c62f13609b7a4ab08b1816c3615bd5f Mon Sep 17 00:00:00 2001 From: Devin Buhl Date: Sun, 21 Apr 2024 08:43:34 -0400 Subject: [PATCH] chore: update config sample to make it clear what github address should look like Signed-off-by: Devin Buhl --- config.sample.yaml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/config.sample.yaml b/config.sample.yaml index 4b5c6eb9..e7f99a0b 100644 --- a/config.sample.yaml +++ b/config.sample.yaml @@ -111,7 +111,7 @@ bootstrap_bgp: # Default is .1 derrived from host_network: ['x.x.x.1'] peers: [] # (Required) Set the BGP Autonomous System Number for the router(s) and nodes. - # If these match, iBGP will be used. If not, eBGP will be used. + # If these match, iBGP will be used. If not, eBGP will be used. peer_asn: "" # Router(s) AS local_asn: "" # Node(s) AS # (Required) The advertised CIDR for the cluster, this must NOT overlap with any @@ -123,7 +123,10 @@ bootstrap_bgp: # 2. (Required) Flux details - Flux is used to manage the cluster configuration. # -# (Required) GitHub repository URL (for private repos use the ssh:// URL) +# (Required) GitHub repository URL +# For a public repo use the 'https://' URL (e.g. "https://github.com/onedr0p/cluster-template.git") +# For a private repo use the 'ssh://' URL (e.g. "ssh://git@github.com:onedr0p/cluster-template.git") +# If using a private repo make sure to following the instructions with the 'bootstrap_github_private_key' option below. bootstrap_github_address: "" # (Required) GitHub repository branch