diff --git a/doc/requirements.txt b/doc/requirements.txt index 0528130..9176473 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -7,6 +7,6 @@ # Put them in here will make it clear that those are only needed for # docs. -sphinx==4.0.0 -otcdocstheme +sphinx>=4.0.0 +otcdocstheme>=1.0.0 reno>=3.1.0 # Apache-2.0 diff --git a/doc/source/cce_vault.rst b/doc/source/cce_vault.rst index ae56308..db73e64 100644 --- a/doc/source/cce_vault.rst +++ b/doc/source/cce_vault.rst @@ -30,9 +30,6 @@ internal credentials. Overview ======== -.. graphviz:: dot/cce_vault_overview.dot - :layout: dot - TLS secrets are kept in the Vault. They are being read by Vault Agent component running as a sidecar in Zookeeper service pod and writes certificates onto the file system. Zookeeper services reads certificates populated by Agent. Vault diff --git a/doc/source/conf.py b/doc/source/conf.py index 23a0f06..1e00610 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -7,10 +7,20 @@ # ones. extensions = [ - 'sphinx.ext.graphviz', - 'otcdocstheme', + 'otcdocstheme' ] +# Those variables are needed for indexing into OpenSearch +otcdocs_doc_environment = 'internal' +otcdocs_doc_link = '' +otcdocs_doc_title = '' +otcdocs_doc_type = '' +otcdocs_service_category = '' +otcdocs_service_title = 'Blueprints' +otcdocs_service_type = 'blueprints' +otcdocs_search_environment = 'hc_de' +otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/" + # openstackdocstheme options otcdocs_repo_name = 'docs/blueprints' @@ -67,8 +77,6 @@ pygments_style = 'native' templates_path = ['templates'] -graphviz_output_format = 'svg' - # -- Options for LaTeX output --------------------------------------------- # Grouping the document tree into LaTeX files. List of tuples diff --git a/doc/source/dot/cce_vault_overview.dot b/doc/source/dot/cce_vault_overview.dot deleted file mode 100644 index 335d37e..0000000 --- a/doc/source/dot/cce_vault_overview.dot +++ /dev/null @@ -1,23 +0,0 @@ -digraph cce_vault { - graph [bgcolor=transparent compound=true fontcolor="#2D3436" - fontname="Sans-Serif" fontsize=10 rankdir="RL"] - node [fixedsize=false] - subgraph cluster_cce { - graph [bgcolor="#E5F5FD" shape=box style=rounded label="CCE" rankdir="LR"] - zk_svc [label="ZK Service" fixedsize=True fontsize=10 height=1.4 - image="../_static/images/k8_svc.png" imagescale="true" labelloc=b - shape=none width=1 rank="min"] - zk_pod1 [label="ZK Pod" fixedsize=True fontsize=10 height=1.4 image="../_static/images/k8_pod.png" imagescale="true" labelloc=b shape=none width=1 rank="same"] - zk_pod2 [label="ZK Pod" fixedsize=True fontsize=10 height=1.4 image="../_static/images/k8_pod.png" imagescale="true" labelloc=b shape=none width=1 rank="same"] - zk_pod3 [label="ZK Pod" fixedsize=True fontsize=10 height=1.4 image="../_static/images/k8_pod.png" imagescale="true" labelloc=b shape=none width=1 rank="same"] - zk_pod1 -> zk_svc - zk_pod2 -> zk_svc - zk_pod3 -> zk_svc - } - vault -> zk_pod1 - vault -> zk_pod2 - vault -> zk_pod3 - vault [label="Vault" fixedsize=True fontsize=10 height=1.4 image="../_static/images/vault.png" imagescale="true" labelloc=b shape=none width=1] - user [label=Clients fixedsize=true fontsize=10 height=1.4 image="../_static/images/users.png" imagescale=true labelloc=b shape=none width=1] - zk_svc -> user [dir=both] -} diff --git a/tox.ini b/tox.ini index 966a2db..d927c61 100644 --- a/tox.ini +++ b/tox.ini @@ -10,7 +10,7 @@ deps = # -c{env:TOX_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/upper-constraints.txt} -r{toxinidir}/doc/requirements.txt sitepackages = False -whitelist_externals = +allowlist_externals = rm [testenv:venv]