Merge pull request #53 from canonical/IAM-961

Migrate to charmcraft.yaml

.github/workflows/tests.yaml

@@ -32,8 +32,7 @@ jobs:
         with:
           provider: microk8s
           channel: 1.28-strict/stable
-          juju-channel: 3.2
-          bootstrap-options: '--agent-version=3.2.0'
+          juju-channel: 3.4
           lxd-channel: 5.20/stable
 
       - name: Run integration tests

README.md

@@ -35,7 +35,7 @@ juju integrate postgresql-k8s:database openfga-k8s
 #### `openfga` interface
 
 Current charm provides a library for the `openfga` integration interface. Your
-application should define an interface in `metadata.yaml`:
+application should define an interface in `charmcraft.yaml`:
 
 ```yaml
 requires:

charmcraft.yaml

@@ -1,17 +1,94 @@
 # This file configures Charmcraft.
 # See https://juju.is/docs/sdk/charmcraft-config for guidance.
 
+name: openfga-k8s
 type: charm
+title: OpenFGA
+summary: A high-performance and flexible authorization/permission engine built for developers and inspired by Google Zanzibar.
+description: |
+  A high-performance and flexible authorization/permission engine
+  built for developers and inspired by Google Zanzibar.
+
+  OpenFGA is designed to make it easy for developers to model
+  their application permissions and add and integrate fine-grained
+  authorization into their applications.
+
+  It allows in-memory data storage for quick development, as well
+  as pluggable database modules. It currently supports PostgreSQL
+  and MySQL.
+
+  It offers an HTTP API and a gRPC API. It has SDKs for
+  Node.js/JavaScript, GoLang, Python and .NET. Look in our
+  Community section for third-party SDKs and tools.
+
+links:
+  documentation: https://discourse.charmhub.io/t/openfga-k8s-docs-index/13826
+  website: https://github.com/canonical/openfga-operator
+  source: https://github.com/canonical/openfga-operator
+  issues: https://github.com/canonical/openfga-operator/issues
+
+peers:
+  peer:
+    interface: openfga-peer
+
+provides:
+  openfga:
+    interface: openfga
+  grafana-dashboard:
+    interface: grafana_dashboard
+  metrics-endpoint:
+    interface: prometheus_scrape
+
+requires:
+  http-ingress:
+    interface: ingress
+    limit: 1
+  grpc-ingress:
+    interface: ingress
+    limit: 1
+  database:
+    interface: postgresql_client
+    limit: 1
+  log-proxy:
+    interface: loki_push_api
+    optional: true
+    limit: 1
+
+containers:
+  openfga:
+    resource: oci-image
+
+resources:
+  oci-image:
+    type: oci-image
+    description: OCI image for OpenFGA
+    upstream-source: ghcr.io/canonical/openfga:1.5.2
+
+config:
+  options:
+    log-level:
+      description: |
+        Configures the log level of gunicorn.
+
+        Acceptable values are: "info", "debug", "warning", "error" and "critical"
+      default: "info"
+      type: string
+
+actions:
+  schema-upgrade:
+    description: Upgrade the application database schema.
+
 parts:
   charm:
-    charm-python-packages: 
+    charm-python-packages:
       - setuptools
     charm-binary-python-packages:
       - requests >= 2.25.1
       - jsonschema >= 3.2.0
       - cryptography >= 3.4.8
       - lightkube
       - lightkube-models
+
 bases:
   - build-on:
       - name: ubuntu

integration-requirements.txt

@@ -1,4 +1,4 @@
 pytest
 juju
-pytest-operator==0.31.1
+pytest-operator==0.35.0
 -r requirements.txt

requirements.txt

@@ -3,5 +3,4 @@ requests == 2.31.0
 jsonschema==4.21.1
 cryptography >= 3.4.8
 lightkube===0.15.0
-lightkube-models==1.29.0.6
 pydantic<2.0

tests/integration/test_charm.py

@@ -13,7 +13,7 @@
 
 logger = logging.getLogger(__name__)
 
-METADATA = yaml.safe_load(Path("./metadata.yaml").read_text())
+METADATA = yaml.safe_load(Path("./charmcraft.yaml").read_text())
 OPENFGA_APP = "openfga"
 TRAEFIK_CHARM = "traefik-k8s"
 TRAEFIK_GRPC_APP = "traefik-grpc"
@@ -40,7 +40,7 @@ async def test_build_and_deploy(ops_test: OpsTest, charm: str, test_charm: str)
             charm, resources=resources, application_name=OPENFGA_APP, series="jammy", trust=True
         ),
         ops_test.model.deploy(
-            "postgresql-k8s", application_name="postgresql", channel="edge", trust=True
+            "postgresql-k8s", application_name="postgresql", channel="14/stable", trust=True
         ),
         ops_test.model.deploy(
             test_charm,

tests/integration/test_upgrade.py

@@ -13,7 +13,7 @@
 
 logger = logging.getLogger(__name__)
 
-METADATA = yaml.safe_load(Path("./metadata.yaml").read_text())
+METADATA = yaml.safe_load(Path("./charmcraft.yaml").read_text())
 APP_NAME = "openfga"