Merge ~gabrielcocenza/juju-lint:bug/1965243 into juju-lint:master

[Gabriel Cocenza]

Added new rules, openstack-loadbalancer and ceph and homer dashboard.

- updated readme
- fcb-stein-bionic
- fcb-ussuri-bionic-ovs
- fcb-ussuri-bionic
- fcb-ussuri-focal-ovs
- fcb-ussuri-focal
- fcb-yoga-focal
- added openstack-loadbalancer for series != bionic
- added ceph-dashboard for openstack releases >= ussuri
- added homer-dashboard as a known charm

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Eric Chen (eric-chen)]

review: Approve

[Martin Kalcok (martin-kalcok)]

LGTM, thanks for the update.

review: Approve

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision 91c90d311b6b02f3b553a7b9eaa0b7167bab4d97

diff --git a/README.md b/README.md
index a99f87c..3ed19f3 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-= Juju Lint =
+# Juju Lint
 
-== Introduction ==
+## Introduction
 
 This is intended to be run against a yaml or json dump of Juju status, a YAML
 dump of a juju bundle, or a remote cloud or clouds via SSH.
@@ -39,18 +39,18 @@ To use a different rules file:
 
 For all other options, consult `juju-lint --help`
 
-== Example ==
+### Example
 
 A typical use case is linting an openstack cloud:
 
     juju status -m openstack --format=json > juju-status.json
     juju export-bundle --include-charm-defaults -m openstack > bundle.yaml
-    juju-lint -c /snap/juju-lint/current/contrib/openstack-focal-ovn.yaml \
+    juju-lint -c /snap/juju-lint/current/contrib/fcb-ussuri-focal.yaml \
         -t openstack juju-status.json
-    juju-lint -c /snap/juju-lint/current/contrib/openstack-focal-ovn.yaml \
+    juju-lint -c /snap/juju-lint/current/contrib/fcb-ussuri-focal.yaml \
         -t openstack bundle.yaml
 
-== Rules File ==
+## Rules File
 
 For an example of a rules file, see `example-lint-rules.yaml`.
 
@@ -66,7 +66,23 @@ Supported top-level options for your rules file:
     mismatches.
  8. `!include <relative path>` - Extension to yaml to include files.
 
-=== Space checks ===
+### Openstack
+
+The snap comes with some standard rules that tries to match the bundles generated on
+[fce-templates](https://launchpad.net/fce-templates/). It's assumed that `ovn` is used
+by default. You can find the rules at `/snap/juju-lint/current/contrib/` and they have
+the following pattern:
+
+```
+fcb-<openstack_release>-<ubuntu-series-feature>.yaml
+```
+
+E.g: fcb-ussuri-focal.yaml, fcb-ussuri-focal-ovs.yaml
+
+#### Note
+The rules starting with `openstack`, e.g: `openstack-bionic-ovn.yaml`, will be deprecated.
+
+## Space checks
 
 All relations defined within a bundle, except for cross-model relationships,
 will be checked for mismatches of their space bindings.
@@ -86,9 +102,9 @@ to ignore them entirely:
  2. `enforce relations` - A list of two-item <charm>:<endpoint> string lists,
     representing the two linked endpoints of a relation.  If a mismatch
     matches one of these relations, it will be flagged as an error.
- 1. `ignore endpoints` - A list of <charm>:<endpoint> strings.  If a mismatch
+ 3. `ignore endpoints` - A list of <charm>:<endpoint> strings.  If a mismatch
     matches one of these endpoints, it will be ignored.
- 1. `ignore relations` - A list of two-item <charm>:<endpoint> string lists,
+ 4. `ignore relations` - A list of two-item <charm>:<endpoint> string lists,
     representing the two linked endpoints of a relation.  If a mismatch
     matches one of these relations, it will be ignored.
 
@@ -98,7 +114,7 @@ rule will "win" and it will be flagged as an error.
 Note that all the above checks use charm names rather than application names
 in their endpoint strings.
 
-== License ==
+## License
 
 Copyright 2020 Canonical Limited.
 License granted by Canonical Limited.
diff --git a/contrib/fcb-stein-bionic.yaml b/contrib/fcb-stein-bionic.yaml
new file mode 100644
index 0000000..863058f
--- /dev/null
+++ b/contrib/fcb-stein-bionic.yaml
@@ -0,0 +1,9 @@
+!include includes/base.yaml
+!include includes/networking/ovn.yaml
+!include includes/database/percona-cluster.yaml
+!include includes/release/stein.yaml
+!include includes/series/bionic.yaml
+!include includes/openstack.yaml
+!include includes/operations.yaml
+!include includes/saas.yaml
+!include includes/aggregator-openstack.yaml
\ No newline at end of file
diff --git a/contrib/fcb-ussuri-bionic-ovs.yaml b/contrib/fcb-ussuri-bionic-ovs.yaml
new file mode 100644
index 0000000..51de731
--- /dev/null
+++ b/contrib/fcb-ussuri-bionic-ovs.yaml
@@ -0,0 +1,9 @@
+!include includes/base.yaml
+!include includes/networking/ovs.yaml
+!include includes/database/percona-cluster.yaml
+!include includes/release/ussuri.yaml
+!include includes/series/bionic.yaml
+!include includes/openstack.yaml
+!include includes/operations.yaml
+!include includes/saas.yaml
+!include includes/aggregator-openstack.yaml
\ No newline at end of file
diff --git a/contrib/fcb-ussuri-bionic.yaml b/contrib/fcb-ussuri-bionic.yaml
new file mode 100644
index 0000000..6fade6b
--- /dev/null
+++ b/contrib/fcb-ussuri-bionic.yaml
@@ -0,0 +1,9 @@
+!include includes/base.yaml
+!include includes/networking/ovn.yaml
+!include includes/database/percona-cluster.yaml
+!include includes/release/ussuri.yaml
+!include includes/series/bionic.yaml
+!include includes/openstack.yaml
+!include includes/operations.yaml
+!include includes/saas.yaml
+!include includes/aggregator-openstack.yaml
\ No newline at end of file
diff --git a/contrib/fcb-ussuri-focal-ovs.yaml b/contrib/fcb-ussuri-focal-ovs.yaml
new file mode 100644
index 0000000..a29ed0e
--- /dev/null
+++ b/contrib/fcb-ussuri-focal-ovs.yaml
@@ -0,0 +1,9 @@
+!include includes/base.yaml
+!include includes/networking/ovs.yaml
+!include includes/database/mysql.yaml
+!include includes/release/ussuri.yaml
+!include includes/series/focal.yaml
+!include includes/openstack.yaml
+!include includes/operations.yaml
+!include includes/saas.yaml
+!include includes/aggregator-openstack.yaml
\ No newline at end of file
diff --git a/contrib/fcb-ussuri-focal.yaml b/contrib/fcb-ussuri-focal.yaml
new file mode 100644
index 0000000..2e6f2eb
--- /dev/null
+++ b/contrib/fcb-ussuri-focal.yaml
@@ -0,0 +1,9 @@
+!include includes/base.yaml
+!include includes/networking/ovn.yaml
+!include includes/database/mysql.yaml
+!include includes/release/ussuri.yaml
+!include includes/series/focal.yaml
+!include includes/openstack.yaml
+!include includes/operations.yaml
+!include includes/saas.yaml
+!include includes/aggregator-openstack.yaml
\ No newline at end of file
diff --git a/contrib/fcb-yoga-focal.yaml b/contrib/fcb-yoga-focal.yaml
new file mode 100644
index 0000000..4293a7d
--- /dev/null
+++ b/contrib/fcb-yoga-focal.yaml
@@ -0,0 +1,9 @@
+!include includes/base.yaml
+!include includes/networking/ovn.yaml
+!include includes/database/mysql.yaml
+!include includes/release/yoga.yaml
+!include includes/series/focal.yaml
+!include includes/openstack.yaml
+!include includes/operations.yaml
+!include includes/saas.yaml
+!include includes/aggregator-openstack.yaml
\ No newline at end of file
diff --git a/contrib/includes/aggregator-openstack.yaml b/contrib/includes/aggregator-openstack.yaml
index 6982a91..58a92fa 100644
--- a/contrib/includes/aggregator-openstack.yaml
+++ b/contrib/includes/aggregator-openstack.yaml
@@ -1,20 +1,22 @@
 operations charms: &operations-charms
- - *operations-mandatory-charms
- - *operations-mandatory-deps
- - *operations-mandatory-subs
- - *operations-optional-charms
- - *operations-optional-subs
- - *operations-openstack-mandatory-charms
+  - *operations-mandatory-charms
+  - *operations-mandatory-deps
+  - *operations-mandatory-subs
+  - *operations-optional-charms
+  - *operations-optional-subs
+  - *operations-openstack-mandatory-charms
+  - *operations-openstack-mandatory-release
 
 openstack charms: &openstack-charms
- - *openstack-mandatory-charms
- - *openstack-mandatory-deps
- - *openstack-mandatory-subs
- - *openstack-optional-charms
- - *cisco-aci-charms
- - *trilio-charms
+  - *openstack-mandatory-charms
+  - *openstack-mandatory-deps
+  - *openstack-mandatory-subs
+  - *openstack-optional-charms
+  - *openstack-loadbalancer
+  - *cisco-aci-charms
+  - *trilio-charms
 
 known charms:
- - ubuntu
- - *openstack-charms
- - *operations-charms
+  - ubuntu
+  - *openstack-charms
+  - *operations-charms
diff --git a/contrib/includes/openstack.yaml b/contrib/includes/openstack.yaml
index 5235aea..1b35486 100644
--- a/contrib/includes/openstack.yaml
+++ b/contrib/includes/openstack.yaml
@@ -45,6 +45,7 @@ openstack mandatory: &openstack-mandatory-charms
  - nova-cloud-controller
  - nova-compute
  - openstack-dashboard
+ - bootstack-charmers-homer-dashboard
  - *openstack-mandatory-charms-networking
 
 openstack mandatory deps base: &openstack-mandatory-deps-base
diff --git a/contrib/includes/release/stein.yaml b/contrib/includes/release/stein.yaml
new file mode 100644
index 0000000..7319287
--- /dev/null
+++ b/contrib/includes/release/stein.yaml
@@ -0,0 +1,4 @@
+# add prometheus ceph exporter if openstack version is lesser than ussuri
+
+operations openstack mandatory release: &operations-openstack-mandatory-release
+  - prometheus-ceph-exporter
\ No newline at end of file
diff --git a/contrib/includes/release/ussuri.yaml b/contrib/includes/release/ussuri.yaml
new file mode 100644
index 0000000..ddf9beb
--- /dev/null
+++ b/contrib/includes/release/ussuri.yaml
@@ -0,0 +1,5 @@
+# Do not add prometheus ceph exporter if openstack version is greater/equal than ussuri
+# Instead, use ceph-dashboard
+
+operations openstack mandatory release: &operations-openstack-mandatory-release
+  - ceph-dashboard
\ No newline at end of file
diff --git a/contrib/includes/release/yoga.yaml b/contrib/includes/release/yoga.yaml
new file mode 100644
index 0000000..ddf9beb
--- /dev/null
+++ b/contrib/includes/release/yoga.yaml
@@ -0,0 +1,5 @@
+# Do not add prometheus ceph exporter if openstack version is greater/equal than ussuri
+# Instead, use ceph-dashboard
+
+operations openstack mandatory release: &operations-openstack-mandatory-release
+  - ceph-dashboard
\ No newline at end of file
diff --git a/contrib/includes/series/bionic.yaml b/contrib/includes/series/bionic.yaml
new file mode 100644
index 0000000..1a9b536
--- /dev/null
+++ b/contrib/includes/series/bionic.yaml
@@ -0,0 +1,2 @@
+openstack loadbalancer: &openstack-loadbalancer []
+operations openstack mandatory series: &operations-openstack-mandatory-series []
diff --git a/contrib/includes/series/focal.yaml b/contrib/includes/series/focal.yaml
new file mode 100644
index 0000000..4084113
--- /dev/null
+++ b/contrib/includes/series/focal.yaml
@@ -0,0 +1,3 @@
+openstack loadbalancer: &openstack-loadbalancer
+  - openstack-loadbalancer
+operations openstack mandatory series: &operations-openstack-mandatory-series []
\ No newline at end of file