- revert metadata name to blueprints

.gitignore

@@ -1,30 +1,26 @@
-*.DS_Store
-*.egg*
-*.log
-*.mo
+_build/
+/AUTHORS
+/ChangeLog
+/dist/
+/otcdocstheme.egg-info/
+.DS_Store
 *.pyc
-*.swo
-*.swp
-*~
-AUTHORS
-octavia_proxy-*/
-.coverage
-.idea
-.stestr/
-.testrepository
-.tox
-build
-ChangeLog
-dist
-# Doc related
 doc/build
+doc/source/BBresult
 api-ref/build
-# Development environment files
-.project
-.pydevproject
-cover
+.tox
+/.venv
+*.swp
+*.log
+*.egg*
+
+# Editors
+*~
+
 # Files created by releasenotes build
 releasenotes/build
-.ropeproject
-test.py
-.vscode
+
+# Files created by the LaTeX/PDF build
+/.aux
+/.fdb_latexmk
+/texput.fls

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+default_language_version:
+  python: python3
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: 9136088a246768144165fcc3ecc3d31bb686920a # v3.3.0
+    hooks:
+      - id: trailing-whitespace
+      # Replaces or checks mixed line ending
+      - id: mixed-line-ending
+        args: ['--fix', 'lf']
+        exclude: '.*\.(svg)$'
+      # Forbid files which have a UTF-8 byte-order marker
+      - id: check-byte-order-marker
+      # Checks that non-binary executables have a proper shebang
+      - id: check-executables-have-shebangs
+      # Check for files that contain merge conflict strings.
+      - id: check-merge-conflict
+      # Check for debugger imports and py37+ breakpoint()
+      # calls in python source
+      - id: debug-statements
+      - id: check-yaml
+        files: .*\.(yaml|yml)$
+  - repo: local
+    hooks:
+      - id: flake8
+        name: flake8
+        additional_dependencies:
+          - hacking>=3.0.1,<3.1.0
+        language: python
+        entry: flake8
+        files: '^.*\.py$'
+        exclude: '^(doc|releasenotes|tools)/.*$'

.zuul.yaml

@@ -0,0 +1,8 @@
+- project:
+    merge-mode: squash-merge
+    default-branch: main
+    vars:
+      # publish to blueprints container
+      container: "blueprints"
+    templates:
+      - publish-otc-docs-hc-pti

bindep.txt

@@ -1 +1,5 @@
+libffi-dev [platform:dpkg]
+libffi-devel [platform:rpm]
+libssl-dev [platform:dpkg]
+openssl-devel [platform:rpm]
 graphviz [doc]

doc/best-practice/source/dot/cce_vault_overview.dot

@@ -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]
-}

doc/best-practice/source/index.rst

@@ -1,8 +0,0 @@
-==========================================
-Welcome to the documentation of Blueprints
-==========================================
-
-.. toctree::
-   :maxdepth: 1
-
-   cce_vault

doc/requirements.txt

@@ -1,10 +1,12 @@
-sphinx>=2.0.0,!=2.1.0 # BSD
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.
+# Notes:
+# reno needs openstackdocstheme which needs reno (cycle dep).
+# os-api-ref needs openstackdocstheme which needs os-api-ref (cycle dep).
+# Put them in here will make it clear that those are only needed for
+# docs.
 
-otcdocstheme # Apache-2.0
-
-# releasenotes
+sphinx>=4.0.0
+otcdocstheme>=1.0.0
 reno>=3.1.0 # Apache-2.0
-
-otc-sphinx-directives>=0.1.0
-sphinx-minify>=0.0.1 # Apache-2.0
-git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata

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

doc/source/index.rst

@@ -1,10 +1,15 @@
 Blueprints
 ==========
 
-.. directive_wrapper::
-   :class: container-sbv
+Users sometimes identify use cases that can be solved in a standardized way to
+save research time and effort. Blueprints are a series of best practices,
+curated by the Open Telekom Cloud engineering and architecture teams. While
+they are not covered directly by the `Service description
+<https://open-telekom-cloud.com/service-description>`_, they are tested and
+validated recommendations from our experts.
 
-   .. service_card::
-      :service_type: blueprints
-      :environment: internal
-      :best-practice: Best Practices emphasize architectural principles that enhance reliability, scalability, and security. This section serves as a valuable resource for architects and developers to implement cloud solutions that align with industry best practices and maximize the benefits of the public cloud infrastructure.
+
+.. toctree::
+   :maxdepth: 1
+
+   cce_vault.rst

requirements.txt

@@ -1,8 +0,0 @@
-# The order of packages is significant, because pip processes them in the order
-# of appearance. Changing the order has an impact on the overall integration
-# process, which may cause wedges in the gate later.
-os-api-ref>=1.4.0 # Apache-2.0
-reno>=3.1.0 # Apache-2.0
-otcdocstheme # Apache-2.0
-sphinx>=2.0.0,!=2.1.0 # BSD
-oslo.i18n>=3.15.3 # Apache-2.0

zuul.yaml

@@ -1,11 +0,0 @@
-- project:
-    merge-mode: squash-merge
-    default-branch: main
-    templates:
-      - helpcenter-base-jobs
-    check:
-      jobs:
-        - noop
-    gate:
-      jobs:
-        - noop