From ff9c70dbc4ed731e6f773d7e2b21deb168906286 Mon Sep 17 00:00:00 2001 From: Eduardo Olivares Date: Tue, 5 Mar 2024 13:26:57 +0100 Subject: [PATCH] Upgrade sphinx version sphinx version upgraded to 5.0 sphinx_rtd_theme version upgraded to 2.0 Depends-On: I80ae1fc69d5e8e2a31ac52c02a1604225eefba3c Change-Id: Ib80988f8b11af93fc4e8bd3affa69795470787fc --- doc/readthedocs_requirements.txt | 2 +- doc/requirements.txt | 4 +- doc/source/_static/tobiko.conf.sample | 110 +++++++++++++++++++------- upper-constraints.txt | 4 +- 4 files changed, 88 insertions(+), 32 deletions(-) diff --git a/doc/readthedocs_requirements.txt b/doc/readthedocs_requirements.txt index ca4b4e69b..3c2b3dfcc 100644 --- a/doc/readthedocs_requirements.txt +++ b/doc/readthedocs_requirements.txt @@ -6,4 +6,4 @@ -r ../test-requirements.txt -r ../extra-requirements.txt -r ./requirements.txt -sphinx_rtd_theme>=0.5.1 # MIT +sphinx_rtd_theme>=2.0 # MIT diff --git a/doc/requirements.txt b/doc/requirements.txt index 70f78ad10..1f5b1349d 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,5 +2,5 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -reno>=3.2.0 # Apache-2.0 -sphinx>=3.4.2 # BSD +reno>=3.2.0 # Apache-2.0 +sphinx>=5.0 # BSD diff --git a/doc/source/_static/tobiko.conf.sample b/doc/source/_static/tobiko.conf.sample index 5f03e917b..5eba66675 100644 --- a/doc/source/_static/tobiko.conf.sample +++ b/doc/source/_static/tobiko.conf.sample @@ -41,6 +41,9 @@ # Default cirros password (string value) #password = +# Default cirros interface name (string value) +#interface_name = + # Default cirros SSH connection timeout (seconds) (floating point value) #connection_timeout = @@ -55,9 +58,12 @@ # From tobiko # -# Default directory where to look for shelves. (string value) +# Directory where to look for shelves. (string value) #shelves_dir = ~/.tobiko/cache/shelves +# Directory where lock persistent files will be saved (string value) +#lock_dir = ~/.tobiko/cache/lock + [glance] @@ -158,6 +164,28 @@ # Clouds file names (list value) #clouds_file_names = clouds.yaml,clouds.yml,clouds.json +# default value in case keystone interface is needed (string value) +#interface = + + +[manila] + +# +# From tobiko +# + +# Share protocol (string value) +#share_protocol = nfs + +# Default size in GB for shares created by share tests. (integer value) +#size = 1 + +# Default share type's name (string value) +#default_share_type_name = default + +# Specifies whether the driver handles the share servers or not (boolean value) +#spec_driver_handles_share_servers = false + [neutron] @@ -178,10 +206,10 @@ #ipv4_prefixlen = 24 # List of nameservers IPv4 addresses (list value) -#ipv4_dns_nameservers = +#ipv4_dns_nameservers = 8.8.8.8 # The CIDR block to allocate IPv6 subnets from (string value) -#ipv6_cidr = 2001:db8::/48 +#ipv6_cidr = fc00::/48 # The mask bits for IPv6 subnets (integer value) #ipv6_prefixlen = 64 @@ -231,6 +259,15 @@ # Default SSH key type to login to server instances (string value) #key_type = ecdsa +# Timeout (in seconds) for establishing connection to ubuntu (floating point value) +#ubuntu_connection_timeout = 1500.0 + +# Timeout (in seconds) till ubuntu server is reachable (floating point value) +#ubuntu_is_reachable_timeout = 900.0 + +# Timeout (in seconds) till cloud-init based server is reachable (floating point value) +#cloudinit_is_reachable_timeout = 600.0 + [octavia] @@ -275,6 +312,43 @@ #timeout = 300.0 +[rhosp] + +# +# From tobiko +# + +# TCP port of SSH server on overcloud or EDPM compute hosts (integer value) +# Deprecated group/name - [tripleo]/overcloud_ssh_port +#ssh_port = + +# Default username used to connect to overcloud or EDPM compute nodes (string value) +# Deprecated group/name - [tripleo]/overcloud_ssh_username +#ssh_username = + +# SSH key filename used to login to Overcloud or EDPM compute nodes (string value) +# Deprecated group/name - [tripleo]/overcloud_ssh_key_filename +#ssh_key_filename = ~/.ssh/osp_ssh_key + +# cloud name to be used for loading credentials (string value) +# Deprecated group/name - [tripleo]/overcloud_cloud_name +#cloud_name = overcloud + +# Default IP address version to be used to connect to overcloud or EDPM compute nodes +# (integer value) +# Deprecated group/name - [tripleo]/overcloud_ip_version +#ip_version = + +# path to where to export tripleo inventory file (string value) +#inventory_file = .ansible/inventory/tripleo.yaml + +# OSP env was done with an external load balancer (boolean value) +#has_external_load_balancer = false + +# whether Ceph RGW is deployed (boolean value) +#ceph_rgw = false + + [shell] # @@ -427,25 +501,13 @@ # files (string value) #undercloud_cloud_name = undercloud -# TCP port of SSH server on overcloud hosts (integer value) -#overcloud_ssh_port = - -# Default username used to connect to overcloud nodes (string value) -#overcloud_ssh_username = - -# SSH key filename used to login to Overcloud nodes (string value) -#overcloud_ssh_key_filename = ~/.ssh/id_overcloud +# Path to cacert file that can be used to send https request from the undercloud (string +# value) +#undercloud_cacert_file = /etc/pki/tls/certs/ca-bundle.trust.crt # Overcloud RC filenames (list value) #overcloud_rcfile = ~/overcloudrc,~/qe-Cloud-0rc -# overcloud cloud name to be used for loading credentials from the overcloud clouds -# files (string value) -#overcloud_cloud_name = overcloud - -# Default IP address version to be used to connect to overcloud nodes (integer value) -#overcloud_ip_version = - # Name of network used to connect to overcloud nodes (string value) #overcloud_network_name = @@ -453,15 +515,6 @@ # value) #overcloud_groups_dict = cmp:compute,ctrl:controller -# path to where to export tripleo inventory file (string value) -#inventory_file = .ansible/inventory/tripleo.yaml - -# OSP env was done with an external load balancer (boolean value) -#has_external_load_balancer = false - -# whether Ceph RGW is deployed (boolean value) -#ceph_rgw = false - [ubuntu] @@ -490,6 +543,9 @@ # Default ubuntu password (string value) #password = +# Default ubuntu interface name (string value) +#interface_name = + # Default ubuntu SSH connection timeout (seconds) (floating point value) #connection_timeout = diff --git a/upper-constraints.txt b/upper-constraints.txt index eb512f388..661d18dd4 100644 --- a/upper-constraints.txt +++ b/upper-constraints.txt @@ -441,9 +441,9 @@ sniffio===1.2.0 snowballstemmer===2.2.0 sortedcontainers===2.4.0 soupsieve===2.3.1 -Sphinx===4.4.0 +Sphinx===5.0.0 sphinx-feature-classification===1.1.0 -sphinx-rtd-theme===1.0.0 +sphinx-rtd-theme===2.0.0 sphinx-testing===1.0.1 sphinxcontrib-actdiag===3.0.0;python_version=='3.8' sphinxcontrib-apidoc===0.3.0