From e6d0e610c576bef70b66ab9c3e8e4460e98bc8f8 Mon Sep 17 00:00:00 2001
From: Mark Goddard <mark@stackhpc.com>
Date: Thu, 4 Jul 2019 19:05:54 +0100
Subject: [PATCH] Deprecate Ceph deployment
There are now several good tools for deploying Ceph, including Ceph
Ansible and ceph-deploy. Maintaining our own Ceph deployment is a
significant maintenance burden, and we should focus on our core mission
to deploy OpenStack. Given that this is a significant part of kolla
ansible currently we will need a long deprecation period and a migration
path to another tool.
Change-Id: Ic603c85c04d8794580a19f9efaa7a8589565f4f6
Partially-Implements: blueprint remove-ceph
---
ansible/roles/ceph/tasks/main.yml | 12 ++++++++++++
doc/source/reference/storage/ceph-guide.rst | 15 ++++++++++++---
.../notes/deprecate-ceph-4745da91c7ca5a8e.yaml | 11 +++++++++++
3 files changed, 35 insertions(+), 3 deletions(-)
create mode 100644 releasenotes/notes/deprecate-ceph-4745da91c7ca5a8e.yaml
diff --git a/ansible/roles/ceph/tasks/main.yml b/ansible/roles/ceph/tasks/main.yml
index bc5d1e6257..ab2a7dcfb6 100644
--- a/ansible/roles/ceph/tasks/main.yml
+++ b/ansible/roles/ceph/tasks/main.yml
@@ -1,2 +1,14 @@
---
+- name: Warn about deprecation
+ debug:
+ msg: >-
+ Support for deploying Ceph via Kolla Ansible is deprecated. In a future
+ release support for deploying Ceph will be removed from Kolla Ansible. Prior
+ to this we will ensure a migration path to another tool such as Ceph
+ Ansible (http://docs.ceph.com/ceph-ansible/master/>) is available. For new
+ deployments it is recommended to use another tool to deploy Ceph to avoid a
+ future migration. This can be integrated with OpenStack by following the
+ external Ceph guide
+ (https://docs.openstack.org/kolla-ansible/latest/reference/storage/external-ceph-guide.html).
+
- include_tasks: "{{ kolla_action }}.yml"
diff --git a/doc/source/reference/storage/ceph-guide.rst b/doc/source/reference/storage/ceph-guide.rst
index 53722674d2..c538a6fdd9 100644
--- a/doc/source/reference/storage/ceph-guide.rst
+++ b/doc/source/reference/storage/ceph-guide.rst
@@ -1,8 +1,17 @@
.. _ceph-guide:
-===============================
-Ceph - Software Defined Storage
-===============================
+============================================
+Ceph - Software Defined Storage (Deprecated)
+============================================
+
+.. warning::
+ Support for deploying Ceph via Kolla Ansible is deprecated. In a future
+ release support for deploying Ceph will be removed from Kolla Ansible. Prior
+ to this we will ensure a migration path to another tool such as `Ceph
+ Ansible <http://docs.ceph.com/ceph-ansible/master/>`__ is available. For new
+ deployments it is recommended to use another tool to deploy Ceph to avoid a
+ future migration. This can be integrated with OpenStack by following
+ :doc:`external-ceph-guide`.
.. note::
The out-of-the-box Ceph deployment requires 3 hosts with at least one block
diff --git a/releasenotes/notes/deprecate-ceph-4745da91c7ca5a8e.yaml b/releasenotes/notes/deprecate-ceph-4745da91c7ca5a8e.yaml
new file mode 100644
index 0000000000..b1550adf38
--- /dev/null
+++ b/releasenotes/notes/deprecate-ceph-4745da91c7ca5a8e.yaml
@@ -0,0 +1,11 @@
+---
+deprecations:
+ - |
+ Deprecates support for deploying Ceph. In a future release support for
+ deploying Ceph will be removed from Kolla Ansible. Prior to this we will
+ ensure a migration path to another tool such as `Ceph Ansible
+ <http://docs.ceph.com/ceph-ansible/master/>`__ is available. For new
+ deployments it is recommended to use another tool to deploy Ceph to avoid a
+ future migration. This can be integrated with OpenStack by following the
+ `external Ceph guide
+ <https://docs.openstack.org/kolla-ansible/latest/reference/storage/external-ceph-guide.html>`__.
--
GitLab