From ae54ae8ef0de840cb0a169536905576a147d1449 Mon Sep 17 00:00:00 2001
From: Jeffrey Zhang <zhang.lei.fly@gmail.com>
Date: Tue, 20 Sep 2016 12:22:40 +0800
Subject: [PATCH] Mark include-footer and include-header deprecated for removal
As we talked in mail list, these two options should be marked for
deprecated and removed in future[0]. Customization footer/header block
are recommended to use.
[0] http://lists.openstack.org/pipermail/openstack-dev/2016-September/102793.html
TrivialFix
Change-Id: I9d0b83b31b3680cf5083eafc2ae491348d3b084b
---
kolla/common/config.py | 6 ++++++
...precated-include-header-and-footer-71f16045920b0100.yaml | 5 +++++
2 files changed, 11 insertions(+)
create mode 100644 releasenotes/notes/deprecated-include-header-and-footer-71f16045920b0100.yaml
diff --git a/kolla/common/config.py b/kolla/common/config.py
index c6c90e1dda..8112ac6a17 100644
--- a/kolla/common/config.py
+++ b/kolla/common/config.py
@@ -76,9 +76,15 @@ _CLI_OPTS = [
cfg.DictOpt('build-args',
help='Set docker build time variables'),
cfg.StrOpt('include-header', short='i',
+ deprecated_for_removal=True,
+ deprecated_reason=('Use a header block within a template'
+ ' overrides file instead'),
help=('Path to custom file to be added at '
'beginning of base Dockerfile')),
cfg.StrOpt('include-footer', short='I',
+ deprecated_for_removal=True,
+ deprecated_reason=('Use a footer block within a template'
+ ' overrides file instead'),
help=('Path to custom file to be added at '
'end of Dockerfiles for final images')),
cfg.BoolOpt('keep', default=False,
diff --git a/releasenotes/notes/deprecated-include-header-and-footer-71f16045920b0100.yaml b/releasenotes/notes/deprecated-include-header-and-footer-71f16045920b0100.yaml
new file mode 100644
index 0000000000..bad40a0d17
--- /dev/null
+++ b/releasenotes/notes/deprecated-include-header-and-footer-71f16045920b0100.yaml
@@ -0,0 +1,5 @@
+---
+features:
+ - deprecated --include-header and --include-footer parameter
+upgrade:
+ - should move use header and footer block in template overrides file