Add upgrade procedure for release notes

Change-Id: I650fa3462193bdea4f36426b904e26c936c4e24e
2020-07-27 14:22:00 +02:00 · 2020-07-27 14:22:00 +02:00 · 2700ababab
parent 9fa03e8a64
commit 2700ababab
1 changed files with 74 additions and 0 deletions
--- a/docs/upgrading-to-stable.md
+++ b/docs/upgrading-to-stable.md
@ -0,0 +1,74 @@
+<!-- WARNING: the release notes
+( https://docs.openstack.org/charm-guide/latest/2008.html ) point to this file.
+Do not delete or move it. -->
+
+# Upgrading to the first stable revision
+
+Prior to the
+[first stable revision](https://jaas.ai/u/openstack-charmers-next/neutron-api-plugin-arista/2)
+the
+[prototype charm](https://jaas.ai/u/openstack-charmers-next/neutron-api-plugin-arista/1)
+relied on a
+[special neutron-api fork](https://jaas.ai/u/aurelien-lourot/neutron-api-arista-test-fixture):
+
+```
+applications:
+
+  neutron-api:
+    charm: cs:~aurelien-lourot/neutron-api-arista-test-fixture
+    options:
+      enable-arista: True
+      manage-neutron-plugin-legacy-mode: True
+      [...]
+
+  neutron-api-plugin-arista:
+    charm: cs:~openstack-charmers-next/neutron-api-plugin-arista-1
+    num_units: 0
+    options:
+      eapi-host: 192.0.2.42
+      eapi-username: admin
+      eapi-password: password123
+      api-type: EAPI
+      service-plugins: router
+
+  [...]
+
+relations:
+- - neutron-api
+  - neutron-api-plugin-arista
+- - neutron-api:neutron-plugin-api-subordinate
+  - neutron-api-plugin-arista:neutron-plugin-api-subordinate
+[...]
+```
+
+The [first stable revision](https://jaas.ai/u/openstack-charmers-next/neutron-api-plugin-arista/2)
+is now a real neutron-api plugin:
+
+```
+applications:
+
+  neutron-api:
+    charm: cs:~openstack-charmers-next/neutron-api
+    options:
+      manage-neutron-plugin-legacy-mode: False
+      # No need for `enable-arista` anymore
+
+  neutron-api-plugin-arista:
+    charm: cs:~openstack-charmers-next/neutron-api-plugin-arista-2
+    num_units: 0
+    options:
+      eapi-host: 192.0.2.42
+      eapi-username: admin
+      eapi-password: password123
+      api-type: EAPI
+      # The misbehaving `service-plugins` option has been removed
+
+  [...]
+
+relations:
+- - neutron-api
+  - neutron-api-plugin-arista
+- - neutron-api:neutron-plugin-api-subordinate
+  - neutron-api-plugin-arista:neutron-plugin-api-subordinate
+[...]
+```