diff --git a/README.rst b/README.rst index c58257f4d..dccd0d626 100644 --- a/README.rst +++ b/README.rst @@ -2,6 +2,13 @@ Hardware introspection for OpenStack Bare Metal =============================================== +.. warning:: + This project is now in the maintenance mode and new deployments of it are + discouraged. Please use `built-in in-band inspection in ironic + `_ + instead. For existing deployments, see the `migration guide + `_. + Introduction ============ diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 212bdf058..2198425eb 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -7,6 +7,11 @@ Bare Metal Introspection API By default **ironic-inspector** listens on ``[::]:5050``, host and port can be changed in the configuration file. Protocol is JSON over HTTP. +.. warning:: + The ironic-inspector project is in the maintenance mode, its API reference + is provided for historical reasons. New applications should use the + `baremetal API `_ instead. + .. rest_expand_all:: .. include:: introspection-api-versions.inc diff --git a/releasenotes/notes/deprecate-d23ae14b5bd3779e.yaml b/releasenotes/notes/deprecate-d23ae14b5bd3779e.yaml new file mode 100644 index 000000000..e459d5fcc --- /dev/null +++ b/releasenotes/notes/deprecate-d23ae14b5bd3779e.yaml @@ -0,0 +1,8 @@ +--- +deprecations: + - | + This project is now in the maintenance mode and new deployments of it are + discouraged. Please use `built-in in-band inspection in ironic + `_ + instead. For existing deployments, see the `migration guide + `_.