A6 Config File Formats

Implementation

Installation is performed using the Ubuntu 24.04 Autoinstall ISO on a USB memory drive, plus a further 3 USBs, one of which is used to install PodNet A, PodNet B and Appliance respectively.

If building a new standalone Pod (containing its own PAT) then you use the procedure in Section 4.2 of this manual to prepare the four USBs. If you are building a Pod that will be managed by an existing PAT then you use the procedure in 4.3 of this manual to prepare the four USBs.

This appendix provides detailed reference information on the parameters of the files in the 3 CIDATA USBs.

Properties for config.json

Property	PAT	COP	Reg	C&R	Dir	Description
Identifier
pod_number	P A	P A	P A	P A	>	= 0 if PAT, < 255 & > 0 for other Pods
pod_name	P A	P A	P A	P A	>	Unique in a Galaxy
blend	P A	P A	P A	P A	>	Blend (Set of Flavors) of the Pod
Public Network (public0)
ipv4_link_subnet	P	P	P	P	>	An IPv4 Link Subnet to an upstream provider
ipv6_link_subnet	P	P	P	P	>	An IPv6 Link Subnet to an upstream provider
podnet_a_public_ifname	P	P	P	P	<	Public Interface Name on Podnet A
podnet_b_public_ifname	P	P	P	P	<	Public Interface Name on Podnet B
OOB Network (oob0)
podnet_a_oob_ifname	P	P	P	P	<	OOB Interface Name on Podnet A
podnet_b_oob_ifname	P	P	P	P	<	OOB Interface Name on Podnet B
Management Network (mgmt0)
primary_ipv4_subnet	P A	P A	P A	P A	>	/29 IPv4 subnet for public Internet connectivity
ipv6_subnet	P A	P A	P A	P A	>	/48 IPv6 subnet for public Internet connectivity
podnet_a_mgmt_ifname	P	P	P	P	<	Management Interface Name on Podnet A
podnet_b_mgmt_ifname	P	P	P	P	<	Management Interface Name on Podnet B
appliance_mgmt_ifname	A	A	A	A	<	Management Interface Name on Appliance
Private Network (private0, private1)
podnet_a_private_ifname	P		P	P	<	Private Interface Name for local Projects on Podnet A
podnet_b_private_ifname	P		P	P	<	Private Interface Name for local Projects on Podnet B
podnet_a_inter_ifname	P		P	P	<	Private Interface Name for remote (vxlan) Projects on Podnet A
podnet_b_inter_ifname	P		P	P	<	Private Interface Name for remote (vxlan) Projects on Podnet B
DNS
dns_ips	P A	P A	P A	P A	>	Comma separated list of IPv4 and IPv6 DNS servers
Ceph Monitors
ceph_monitors			A	A	>	Comma separated list of IPv6 addresses of the Ceph Monitors
HA
podnet_a_enable	P A	P A	P A	P A	<	Boolean indicating if Podnet A is enabled, by default is set to false
podnet_b_enable	P A	P A	P A	P A	<	Boolean indicating if Podnet B is enabled, by default is set to false

Properties for .env

Property	PAT	COP	Reg	C&R	Dir	Description
Network
docker_mgmt_ip6	A	A	A	A	>	Docker management network
pms3	A	A	A	A	>	Third IP of the primary_ipv4_subnet
pms4	A	A	A	A	>	Fourth IP of the primary_ipv4_subnet
pms5	A	A	A	A	>	Fifth IP of the primary_ipv4_subnet
pms6	A	A	A	A	>	Sixth IP of the primary_ipv4_subnet
Common
pod_number	A	A	A	A	>	= 0 if PAT, < 255 & > 0 for other Pods
pod_name	A	A	A	A	>	Unique in a Galaxy
organisation_url	A	A	A	A	>	Organisationaly Unique
cloudcix_version	A	A	A	A	>	Major Version of CloudCIX software
email_host	A	A	A	A	>	Email server where the notifications are sent from
email_user	A	A	A	A	>	Email address to sign into Email Host
email_password	A	A	A	A	>	Email user password
email_port	A	A	A	A	>	Email SMTP port
email_reply_to	A	A	A	A	>	Reply to email address
pat_name	A	A	A	A	>	PAT name
pat_organisation_url	A	A	A	A	>	PAT domain name
portal_name	A	A	A	A	>	Portal subdomain
COP
cloudcix_api_username	A	A		A	>	API user
cloudcix_api_password	A	A		A	>	API user password
cloudcix_api_key	A	A		A	>	API key
pod_secret_key	A	A		A	>	Django secret key
pgsqlapi_user	A	A		A	>	Postgres API db user
pgsqlapi_password	A	A		A	>	Postgres API db password
pgsqltotp_user	A	A		A	>	Postgres TOTP db user
pgsqltotp_password	A	A		A	>	Postgres TOTP db password
pgadmin_email	A	A		A	>	pgAdmin login email
pgadmin_password	A	A		A	>	pgAdmin login password
membershipldap_dc	A	A		A	>	LDAP domain components
membershipldap_password	A	A		A	>	LDAP admin password
Region
robot_api_username	A		A	A	>	Robot user username
robot_api_key	A		A	A	>	Robot user API key
robot_api_password	A		A	A	>	Robot user password
cop_name	A		A	A	>	COP name
cop_organisation_url	A		A	A	>	COP organisation url
cloudcix_lock_user	A		A	A	>	Postgres Lock db user
cloudcix_lock_credentials	A		A	A	>	Postgres Lock db password

Properties for user-data

Property	Dir	Description
Podnet
pod_name	>	Sets hostname name -> pod_name-podnet_a
pat_public_key	>	Public Key of the PAT for the Pod
ipv4_link_pe	>	Providers edge IPv4, part of ipv4_link_subnet
ipv4_link_cpe	>	Customer premises equipment IPv4, part of ipv4_link_subnet
ipv6_link_pe	>	Providers edge IPv6, part of ipv6_link_subnet
ipv6_link_cpe	>	Customer premises equipment IPv6, part of ipv6_link subnet
ipv4_link_subnet_mask	>	Subnet mask of the ipv4_link_subnet -> e.g. /29
ipv6_link_subnet_mask	>	Subnet mask of the ipv6_link_subnet -> e.g. /126
dns_ips	>	Comma separated list of IPv4 and IPv6 DNS servers
Appliance
pat_public_key	>	Public Key of the PAT for the Pod
pod_name	>	Set hostname name -> pod_name-appliance_a
pod_number	>	Pod number, used in ssh key pair generation
pms1	>	First usable IP of the primary_ipv4_subnet
pms2	>	Second usable IP of the primary_ipv4_subnet
pms3	>	Third usable IP of the primary_ipv4_subnet
pms4	>	Fourth usable IP of the primary_ipv4_subnet
pms5	>	Fifth usable IP of the primary_ipv4_subnet
pms6	>	Sixth usable IP of the primary_ipv4_subnet
pms_subnet_mask	>	Subnet mask of the primary_ipv4_subnet -> e.g /24
ipv6_subnet_no_netmask	>	ipv6_subnet without net mask -> 2a02:2078:18::
dns_ips	>	Comma separated list of IPv4 and Ipv6 DNS servers