From 9448f7ccae15fea3a7bb7332dfdbfef638e34b24 Mon Sep 17 00:00:00 2001
From: Liam Young <liam.young@canonical.com>
Date: Tue, 8 Nov 2022 13:08:18 +0000
Subject: [PATCH] Open the Antelope Specs

Open the Antelope cycle specs (a bit late, but better late than never).

Change-Id: I0a6be44a0b1d79ef54be0c5905734df5b032c4c7
---
 doc/source/index.rst                          |   2 +
 doc/source/specs/antelope/approved            |   1 +
 doc/source/specs/antelope/backlog             |   1 +
 doc/source/specs/antelope/implemented         |   1 +
 doc/source/specs/antelope/index.rst           |  25 ++++
 doc/source/specs/antelope/redirects           |   1 +
 doc/source/specs/antelope/template.rst        | 125 ++++++++++++++++++
 doc/source/specs/yoga/index.rst               |  17 +--
 doc/source/specs/zed/approved                 |   1 +
 doc/source/specs/zed/backlog                  |   1 +
 doc/source/specs/zed/implemented              |   1 +
 doc/source/specs/zed/index.rst                |  18 +++
 doc/source/specs/zed/redirects                |   1 +
 doc/source/specs/zed/template.rst             | 125 ++++++++++++++++++
 specs/antelope/backlog/.keep                  |   0
 .../backlog/audit-middleware.rst              |   0
 .../backlog/ceph-storage-action.rst           |   0
 .../backlog}/cinder-nimblestorage.rst         |   7 +-
 .../backlog}/cinder-solidfire.rst             |   0
 .../backlog}/memory-fragmentation-tuning.rst  |   0
 .../ncc-migration-ssh-auth-sharing.rst        |   0
 .../backlog/numa-live-migration.rst           |   0
 .../backlog}/ovn-central-downscaling.rst      |   0
 ...using-charms-hacluster-no-false-alerts.rst |   0
 .../backlog}/prometheus-metrics-exporter.rst  |   0
 .../rabbitmq-quorum-queue-support.rst         |   0
 .../release-notes-migration-to-reno.rst       |   0
 .../backlog/service-discovery.rst             |   0
 .../swift-extended-cluster-operations.rst     |   0
 specs/antelope/implemented/.keep              |   0
 specs/antelope/redirects                      |   0
 .../cinder-backup-swift.rst                   |   0
 .../nvidia-vgpu-support.rst                   |   0
 .../vtpm-support.rst                          |   0
 specs/zed/approved/.keep                      |   0
 specs/zed/backlog/.keep                       |   0
 .../designate-bind-service-ip.rst             |   0
 .../implemented}/keystone-openidc.rst         |   0
 specs/zed/redirects                           |   0
 39 files changed, 308 insertions(+), 19 deletions(-)
 create mode 120000 doc/source/specs/antelope/approved
 create mode 120000 doc/source/specs/antelope/backlog
 create mode 120000 doc/source/specs/antelope/implemented
 create mode 100644 doc/source/specs/antelope/index.rst
 create mode 120000 doc/source/specs/antelope/redirects
 create mode 100644 doc/source/specs/antelope/template.rst
 create mode 120000 doc/source/specs/zed/approved
 create mode 120000 doc/source/specs/zed/backlog
 create mode 120000 doc/source/specs/zed/implemented
 create mode 100644 doc/source/specs/zed/index.rst
 create mode 120000 doc/source/specs/zed/redirects
 create mode 100644 doc/source/specs/zed/template.rst
 create mode 100644 specs/antelope/backlog/.keep
 rename specs/{yoga => antelope}/backlog/audit-middleware.rst (100%)
 rename specs/{yoga => antelope}/backlog/ceph-storage-action.rst (100%)
 rename specs/{yoga/approved => antelope/backlog}/cinder-nimblestorage.rst (96%)
 rename specs/{yoga/approved => antelope/backlog}/cinder-solidfire.rst (100%)
 rename specs/{yoga/approved => antelope/backlog}/memory-fragmentation-tuning.rst (100%)
 rename specs/{yoga/approved => antelope/backlog}/ncc-migration-ssh-auth-sharing.rst (100%)
 rename specs/{yoga => antelope}/backlog/numa-live-migration.rst (100%)
 rename specs/{yoga/approved => antelope/backlog}/ovn-central-downscaling.rst (100%)
 rename specs/{yoga/approved => antelope/backlog}/pausing-charms-hacluster-no-false-alerts.rst (100%)
 rename specs/{yoga/approved => antelope/backlog}/prometheus-metrics-exporter.rst (100%)
 rename specs/{yoga/approved => antelope/backlog}/rabbitmq-quorum-queue-support.rst (100%)
 rename specs/{yoga => antelope}/backlog/release-notes-migration-to-reno.rst (100%)
 rename specs/{yoga => antelope}/backlog/service-discovery.rst (100%)
 rename specs/{yoga => antelope}/backlog/swift-extended-cluster-operations.rst (100%)
 create mode 100644 specs/antelope/implemented/.keep
 create mode 100644 specs/antelope/redirects
 rename specs/yoga/{backlog => implemented}/cinder-backup-swift.rst (100%)
 rename specs/yoga/{approved => implemented}/nvidia-vgpu-support.rst (100%)
 rename specs/yoga/{approved => implemented}/vtpm-support.rst (100%)
 create mode 100644 specs/zed/approved/.keep
 create mode 100644 specs/zed/backlog/.keep
 rename specs/{yoga/approved => zed/implemented}/designate-bind-service-ip.rst (100%)
 rename specs/{yoga/approved => zed/implemented}/keystone-openidc.rst (100%)
 create mode 100644 specs/zed/redirects

diff --git a/doc/source/index.rst b/doc/source/index.rst
index 560f8e3..d2d2829 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -11,6 +11,8 @@ Here you can find the specs, and spec template, for each release:
    :glob:
    :maxdepth: 1
 
+   specs/antelope/index
+   specs/zed/index
    specs/yoga/index
    specs/xena/index
    specs/wallaby/index
diff --git a/doc/source/specs/antelope/approved b/doc/source/specs/antelope/approved
new file mode 120000
index 0000000..4f74783
--- /dev/null
+++ b/doc/source/specs/antelope/approved
@@ -0,0 +1 @@
+../../../../specs/antelope/approved
\ No newline at end of file
diff --git a/doc/source/specs/antelope/backlog b/doc/source/specs/antelope/backlog
new file mode 120000
index 0000000..d511f92
--- /dev/null
+++ b/doc/source/specs/antelope/backlog
@@ -0,0 +1 @@
+../../../../specs/antelope/backlog
\ No newline at end of file
diff --git a/doc/source/specs/antelope/implemented b/doc/source/specs/antelope/implemented
new file mode 120000
index 0000000..b5d5e0b
--- /dev/null
+++ b/doc/source/specs/antelope/implemented
@@ -0,0 +1 @@
+../../../../specs/antelope/implemented
\ No newline at end of file
diff --git a/doc/source/specs/antelope/index.rst b/doc/source/specs/antelope/index.rst
new file mode 100644
index 0000000..771fdf0
--- /dev/null
+++ b/doc/source/specs/antelope/index.rst
@@ -0,0 +1,25 @@
+=============================
+Charm Antelope Specifications
+=============================
+
+Template:
+
+.. toctree::
+   :maxdepth: 1
+
+   Specification Template (Antelope release) <template>
+
+Antelope implemented specs:
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+
+Antelope backlog (carried over from previous cycle) specs:
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   backlog/*
diff --git a/doc/source/specs/antelope/redirects b/doc/source/specs/antelope/redirects
new file mode 120000
index 0000000..96c8157
--- /dev/null
+++ b/doc/source/specs/antelope/redirects
@@ -0,0 +1 @@
+../../../../specs/antelope/redirects
\ No newline at end of file
diff --git a/doc/source/specs/antelope/template.rst b/doc/source/specs/antelope/template.rst
new file mode 100644
index 0000000..bcf1944
--- /dev/null
+++ b/doc/source/specs/antelope/template.rst
@@ -0,0 +1,125 @@
+..
+  Copyright <YEARS> <HOLDER>  <--UPDATE THESE
+
+  This work is licensed under a Creative Commons Attribution 3.0
+  Unported License.
+  http://creativecommons.org/licenses/by/3.0/legalcode
+
+..
+  This template should be in ReSTructured text. Please do not delete
+  any of the sections in this template.  If you have nothing to say
+  for a whole section, just write: "None". For help with syntax, see
+  http://sphinx-doc.org/rest.html To test out your formatting, see
+  http://www.tele3.cz/jbar/rest/rest.html
+
+===============================
+The Title of Your Specification
+===============================
+
+Introduction paragraph -- why are we doing anything?
+
+Problem Description
+===================
+
+A detailed description of the problem.
+
+Proposed Change
+===============
+
+Here is where you cover the change you propose to make in detail. How do you
+propose to solve this problem?
+
+If this is one part of a larger effort make it clear where this piece ends. In
+other words, what's the scope of this effort?
+
+What versions of the operating system are affected or required?
+
+What versions of OpenStack are affected or required?
+
+What version of Juju is required?
+
+Alternatives
+------------
+
+This is an optional section, where it does apply we'd just like a demonstration
+that some thought has been put into why the proposed approach is the best one.
+
+Implementation
+==============
+
+Assignee(s)
+-----------
+
+Who is leading the writing of the code? Or is this a blueprint where you're
+throwing it out there to see who picks it up?
+
+If more than one person is working on the implementation, please designate the
+primary author and contact.
+
+Primary assignee:
+  <launchpad-id or None>
+
+Can optionally list additional ids if they intend on doing substantial
+implementation work on this blueprint.
+
+Gerrit Topic
+------------
+
+Use Gerrit topic "<topic_name>" for all patches related to this spec.
+
+.. code-block:: bash
+
+    git-review -t <topic_name>
+
+Work Items
+----------
+
+Work items or tasks -- break the feature up into the things that need to be
+done to implement it. Those parts might end up being done by different people,
+but we're mostly trying to understand the timeline for implementation.
+
+Repositories
+------------
+
+Will any new git repositories need to be created?
+
+Identify all new charm repos, interface repos, layer repos, whether new or
+existing, which will be affected or involved directly in the work which is
+defined by this spec.
+
+Documentation
+-------------
+
+Will this require a documentation change?  If so, which documents?
+Will it impact developer workflow?  Will additional communication need
+to be made?
+
+Identify the surface area of doc updates explicitly, ie. charm-guide,
+deployment-guide, charm README, wiki page links.
+
+Security
+--------
+
+Does this introduce any additional security risks, or are there
+security-related considerations which should be discussed?
+
+Testing
+-------
+
+What tests will be available or need to be constructed in order to
+validate this?  Unit/functional tests, development
+environments/servers, etc.
+
+Are there any special hardware requirements to test this?
+
+Dependencies
+============
+
+- Include specific references to specs and/or stories, or in
+  other projects, that this one either depends on or is related to.
+
+- Does this feature require any new library or program dependencies
+  not already in use?
+
+- What are the plans to package and distribute the payload and/or
+  dependencies?
diff --git a/doc/source/specs/yoga/index.rst b/doc/source/specs/yoga/index.rst
index bced459..8f5c97f 100644
--- a/doc/source/specs/yoga/index.rst
+++ b/doc/source/specs/yoga/index.rst
@@ -15,19 +15,4 @@ Yoga implemented specs:
    :glob:
    :maxdepth: 1
 
-
-Yoga approved (but not implemented) specs:
-
-.. toctree::
-   :glob:
-   :maxdepth: 1
-
-   approved/*
-
-Yoga backlog (carried over from previous cycle) specs:
-
-.. toctree::
-   :glob:
-   :maxdepth: 1
-
-   backlog/*
+   implemented/*
diff --git a/doc/source/specs/zed/approved b/doc/source/specs/zed/approved
new file mode 120000
index 0000000..7a66547
--- /dev/null
+++ b/doc/source/specs/zed/approved
@@ -0,0 +1 @@
+../../../../specs/zed/approved
\ No newline at end of file
diff --git a/doc/source/specs/zed/backlog b/doc/source/specs/zed/backlog
new file mode 120000
index 0000000..7da99fa
--- /dev/null
+++ b/doc/source/specs/zed/backlog
@@ -0,0 +1 @@
+../../../../specs/zed/backlog/
\ No newline at end of file
diff --git a/doc/source/specs/zed/implemented b/doc/source/specs/zed/implemented
new file mode 120000
index 0000000..39b0da0
--- /dev/null
+++ b/doc/source/specs/zed/implemented
@@ -0,0 +1 @@
+../../../../specs/zed/implemented
\ No newline at end of file
diff --git a/doc/source/specs/zed/index.rst b/doc/source/specs/zed/index.rst
new file mode 100644
index 0000000..948e242
--- /dev/null
+++ b/doc/source/specs/zed/index.rst
@@ -0,0 +1,18 @@
+=============================
+Charm Zed Specifications
+=============================
+
+Template:
+
+.. toctree::
+   :maxdepth: 1
+
+   Specification Template (Zed release) <template>
+
+Zed implemented specs:
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   implemented/*
diff --git a/doc/source/specs/zed/redirects b/doc/source/specs/zed/redirects
new file mode 120000
index 0000000..a1a481f
--- /dev/null
+++ b/doc/source/specs/zed/redirects
@@ -0,0 +1 @@
+../../../../specs/zed/redirects
\ No newline at end of file
diff --git a/doc/source/specs/zed/template.rst b/doc/source/specs/zed/template.rst
new file mode 100644
index 0000000..bcf1944
--- /dev/null
+++ b/doc/source/specs/zed/template.rst
@@ -0,0 +1,125 @@
+..
+  Copyright <YEARS> <HOLDER>  <--UPDATE THESE
+
+  This work is licensed under a Creative Commons Attribution 3.0
+  Unported License.
+  http://creativecommons.org/licenses/by/3.0/legalcode
+
+..
+  This template should be in ReSTructured text. Please do not delete
+  any of the sections in this template.  If you have nothing to say
+  for a whole section, just write: "None". For help with syntax, see
+  http://sphinx-doc.org/rest.html To test out your formatting, see
+  http://www.tele3.cz/jbar/rest/rest.html
+
+===============================
+The Title of Your Specification
+===============================
+
+Introduction paragraph -- why are we doing anything?
+
+Problem Description
+===================
+
+A detailed description of the problem.
+
+Proposed Change
+===============
+
+Here is where you cover the change you propose to make in detail. How do you
+propose to solve this problem?
+
+If this is one part of a larger effort make it clear where this piece ends. In
+other words, what's the scope of this effort?
+
+What versions of the operating system are affected or required?
+
+What versions of OpenStack are affected or required?
+
+What version of Juju is required?
+
+Alternatives
+------------
+
+This is an optional section, where it does apply we'd just like a demonstration
+that some thought has been put into why the proposed approach is the best one.
+
+Implementation
+==============
+
+Assignee(s)
+-----------
+
+Who is leading the writing of the code? Or is this a blueprint where you're
+throwing it out there to see who picks it up?
+
+If more than one person is working on the implementation, please designate the
+primary author and contact.
+
+Primary assignee:
+  <launchpad-id or None>
+
+Can optionally list additional ids if they intend on doing substantial
+implementation work on this blueprint.
+
+Gerrit Topic
+------------
+
+Use Gerrit topic "<topic_name>" for all patches related to this spec.
+
+.. code-block:: bash
+
+    git-review -t <topic_name>
+
+Work Items
+----------
+
+Work items or tasks -- break the feature up into the things that need to be
+done to implement it. Those parts might end up being done by different people,
+but we're mostly trying to understand the timeline for implementation.
+
+Repositories
+------------
+
+Will any new git repositories need to be created?
+
+Identify all new charm repos, interface repos, layer repos, whether new or
+existing, which will be affected or involved directly in the work which is
+defined by this spec.
+
+Documentation
+-------------
+
+Will this require a documentation change?  If so, which documents?
+Will it impact developer workflow?  Will additional communication need
+to be made?
+
+Identify the surface area of doc updates explicitly, ie. charm-guide,
+deployment-guide, charm README, wiki page links.
+
+Security
+--------
+
+Does this introduce any additional security risks, or are there
+security-related considerations which should be discussed?
+
+Testing
+-------
+
+What tests will be available or need to be constructed in order to
+validate this?  Unit/functional tests, development
+environments/servers, etc.
+
+Are there any special hardware requirements to test this?
+
+Dependencies
+============
+
+- Include specific references to specs and/or stories, or in
+  other projects, that this one either depends on or is related to.
+
+- Does this feature require any new library or program dependencies
+  not already in use?
+
+- What are the plans to package and distribute the payload and/or
+  dependencies?
diff --git a/specs/antelope/backlog/.keep b/specs/antelope/backlog/.keep
new file mode 100644
index 0000000..e69de29
diff --git a/specs/yoga/backlog/audit-middleware.rst b/specs/antelope/backlog/audit-middleware.rst
similarity index 100%
rename from specs/yoga/backlog/audit-middleware.rst
rename to specs/antelope/backlog/audit-middleware.rst
diff --git a/specs/yoga/backlog/ceph-storage-action.rst b/specs/antelope/backlog/ceph-storage-action.rst
similarity index 100%
rename from specs/yoga/backlog/ceph-storage-action.rst
rename to specs/antelope/backlog/ceph-storage-action.rst
diff --git a/specs/yoga/approved/cinder-nimblestorage.rst b/specs/antelope/backlog/cinder-nimblestorage.rst
similarity index 96%
rename from specs/yoga/approved/cinder-nimblestorage.rst
rename to specs/antelope/backlog/cinder-nimblestorage.rst
index a6f58d4..e263ffc 100644
--- a/specs/yoga/approved/cinder-nimblestorage.rst
+++ b/specs/antelope/backlog/cinder-nimblestorage.rst
@@ -37,8 +37,8 @@ are of condiderable importance for the development of this subordinate charm:
 * The new charm should implement all features currently existing in the cinder
   charm, regarding the nimblestorage functionality.
 
-Note that because the Nimblestorage driver is part of the cinder-common package, no
-additional packages need to be installed for this charm to work.
+Note that because the Nimblestorage driver is part of the cinder-common
+package, no additional packages need to be installed for this charm to work.
 
 This charm would be supported in the Ussuri release of Openstack and newer.
 
@@ -62,7 +62,8 @@ Secondary assignee:
 Gerrit Topic
 ------------
 
-Use Gerrit topic "charm-cinder-nimblestorage" for all patches related to this spec.
+Use Gerrit topic "charm-cinder-nimblestorage" for all patches related to this
+spec.
 
 .. code-block:: bash
 
diff --git a/specs/yoga/approved/cinder-solidfire.rst b/specs/antelope/backlog/cinder-solidfire.rst
similarity index 100%
rename from specs/yoga/approved/cinder-solidfire.rst
rename to specs/antelope/backlog/cinder-solidfire.rst
diff --git a/specs/yoga/approved/memory-fragmentation-tuning.rst b/specs/antelope/backlog/memory-fragmentation-tuning.rst
similarity index 100%
rename from specs/yoga/approved/memory-fragmentation-tuning.rst
rename to specs/antelope/backlog/memory-fragmentation-tuning.rst
diff --git a/specs/yoga/approved/ncc-migration-ssh-auth-sharing.rst b/specs/antelope/backlog/ncc-migration-ssh-auth-sharing.rst
similarity index 100%
rename from specs/yoga/approved/ncc-migration-ssh-auth-sharing.rst
rename to specs/antelope/backlog/ncc-migration-ssh-auth-sharing.rst
diff --git a/specs/yoga/backlog/numa-live-migration.rst b/specs/antelope/backlog/numa-live-migration.rst
similarity index 100%
rename from specs/yoga/backlog/numa-live-migration.rst
rename to specs/antelope/backlog/numa-live-migration.rst
diff --git a/specs/yoga/approved/ovn-central-downscaling.rst b/specs/antelope/backlog/ovn-central-downscaling.rst
similarity index 100%
rename from specs/yoga/approved/ovn-central-downscaling.rst
rename to specs/antelope/backlog/ovn-central-downscaling.rst
diff --git a/specs/yoga/approved/pausing-charms-hacluster-no-false-alerts.rst b/specs/antelope/backlog/pausing-charms-hacluster-no-false-alerts.rst
similarity index 100%
rename from specs/yoga/approved/pausing-charms-hacluster-no-false-alerts.rst
rename to specs/antelope/backlog/pausing-charms-hacluster-no-false-alerts.rst
diff --git a/specs/yoga/approved/prometheus-metrics-exporter.rst b/specs/antelope/backlog/prometheus-metrics-exporter.rst
similarity index 100%
rename from specs/yoga/approved/prometheus-metrics-exporter.rst
rename to specs/antelope/backlog/prometheus-metrics-exporter.rst
diff --git a/specs/yoga/approved/rabbitmq-quorum-queue-support.rst b/specs/antelope/backlog/rabbitmq-quorum-queue-support.rst
similarity index 100%
rename from specs/yoga/approved/rabbitmq-quorum-queue-support.rst
rename to specs/antelope/backlog/rabbitmq-quorum-queue-support.rst
diff --git a/specs/yoga/backlog/release-notes-migration-to-reno.rst b/specs/antelope/backlog/release-notes-migration-to-reno.rst
similarity index 100%
rename from specs/yoga/backlog/release-notes-migration-to-reno.rst
rename to specs/antelope/backlog/release-notes-migration-to-reno.rst
diff --git a/specs/yoga/backlog/service-discovery.rst b/specs/antelope/backlog/service-discovery.rst
similarity index 100%
rename from specs/yoga/backlog/service-discovery.rst
rename to specs/antelope/backlog/service-discovery.rst
diff --git a/specs/yoga/backlog/swift-extended-cluster-operations.rst b/specs/antelope/backlog/swift-extended-cluster-operations.rst
similarity index 100%
rename from specs/yoga/backlog/swift-extended-cluster-operations.rst
rename to specs/antelope/backlog/swift-extended-cluster-operations.rst
diff --git a/specs/antelope/implemented/.keep b/specs/antelope/implemented/.keep
new file mode 100644
index 0000000..e69de29
diff --git a/specs/antelope/redirects b/specs/antelope/redirects
new file mode 100644
index 0000000..e69de29
diff --git a/specs/yoga/backlog/cinder-backup-swift.rst b/specs/yoga/implemented/cinder-backup-swift.rst
similarity index 100%
rename from specs/yoga/backlog/cinder-backup-swift.rst
rename to specs/yoga/implemented/cinder-backup-swift.rst
diff --git a/specs/yoga/approved/nvidia-vgpu-support.rst b/specs/yoga/implemented/nvidia-vgpu-support.rst
similarity index 100%
rename from specs/yoga/approved/nvidia-vgpu-support.rst
rename to specs/yoga/implemented/nvidia-vgpu-support.rst
diff --git a/specs/yoga/approved/vtpm-support.rst b/specs/yoga/implemented/vtpm-support.rst
similarity index 100%
rename from specs/yoga/approved/vtpm-support.rst
rename to specs/yoga/implemented/vtpm-support.rst
diff --git a/specs/zed/approved/.keep b/specs/zed/approved/.keep
new file mode 100644
index 0000000..e69de29
diff --git a/specs/zed/backlog/.keep b/specs/zed/backlog/.keep
new file mode 100644
index 0000000..e69de29
diff --git a/specs/yoga/approved/designate-bind-service-ip.rst b/specs/zed/implemented/designate-bind-service-ip.rst
similarity index 100%
rename from specs/yoga/approved/designate-bind-service-ip.rst
rename to specs/zed/implemented/designate-bind-service-ip.rst
diff --git a/specs/yoga/approved/keystone-openidc.rst b/specs/zed/implemented/keystone-openidc.rst
similarity index 100%
rename from specs/yoga/approved/keystone-openidc.rst
rename to specs/zed/implemented/keystone-openidc.rst
diff --git a/specs/zed/redirects b/specs/zed/redirects
new file mode 100644
index 0000000..e69de29