Add migration guide in changelog, improve readme

Signed-off-by: Jan Dittrich <jan.dittrich@cgm.com>

Author: jan-di

CHANGELOG.md

@@ -7,12 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Migration from 0.4.0
+
+- In compliance with the Community Extension Projects Policies, we moved the provider to the new crossplane package registry. The provider will be available at `xpkg.crossplane.io/crossplane-contrib/provider-openstack`. The previously published packages in the Upbound Marketplace will no longer be updated but kept there for backwards compatbility.
+
 ### Added
 
 - All remaining config parameters that are supported via [terraform-provider-openstack](https://registry.terraform.io/providers/terraform-provider-openstack)
 - Made it easier to configure authentication by not requiring so many fields.
 - Migrated to Upjets new No-Fork/Provider v2 SDK Architecture. The provider now does not ship with Terraform CLI anymore.
 - Added many cross resource references (autmatically generated from Terraform provider schema)
+- Add native metrics for managed resources (see [Upjet 1.3.0](https://github.com/crossplane/upjet/releases/tag/v1.3.0) for more details)
 
 ### Changed
 
@@ -25,6 +30,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Modernize CI Pipeline
 - Rebase dockerfle to alpine 3.12
 
+### Removed
+
+- Removed Terraform CLI specific metrics, as there is no Terraform CLI involved anymore
+
 ## [0.4.0] - 2024-06-11
 
 ### Added

README.md

@@ -3,7 +3,6 @@
 <div align="center">
 
 [![GitHub release](https://img.shields.io/github/release/crossplane-contrib/provider-openstack/all.svg)](https://github.com/crossplane-contrib/provider-openstack/releases)
-[![Upbound Marketplace](https://img.shields.io/badge/provider--openstack-xxx?label=upbound%20marketplace&color=blue)](https://marketplace.upbound.io/providers/crossplane-contrib/provider-openstack)
 
 </div>
 
@@ -14,33 +13,25 @@ OpenStack API.
 
 ## Getting Started
 
-Install the provider by using the following command after changing the image tag
-to the [latest release](https://marketplace.upbound.io/providers/crossplane-contrib/provider-openstack):
+### Installation
 
-```
-up ctp provider install crossplane-contrib/provider-openstack:vX.X.X
-```
-
-Alternatively, you can use declarative installation:
+You can use declarative installation to install the provider:
 
-```
-cat <<EOF | kubectl apply -f -
+```yaml
 apiVersion: pkg.crossplane.io/v1
 kind: Provider
 metadata:
   name: provider-openstack
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/provider-openstack:vX.Y.Z
-EOF
+  package: xpkg.crossplane.io/crossplane-contrib/provider-openstack:vX.Y.Z
 ```
 
-Notice that in this example Provider resource is referencing ControllerConfig with debug enabled.
-
 You can see the API reference [here](https://doc.crds.dev/github.com/crossplane-contrib/provider-openstack).
 
-## Configuration
+### Configuration
 
 ```yaml
+---
 # Providerconfig that referers to the secret
 apiVersion: openstack.crossplane.io/v1beta1
 kind: ProviderConfig
@@ -53,6 +44,7 @@ spec:
       key: config
       name: provider-openstack-config
       namespace: crossplane
+
 ---
 # Secret that stores credentials and other configuration
 apiVersion: v1
@@ -68,7 +60,9 @@ data:
 The secret key must contain a json dictionary that provides the authentication data.
 You can create the secret via this command:
 
-`kubectl create secret generic provider-openstack-config --from-file=config=config.json --namespace crossplane`
+```bash
+kubectl create secret generic provider-openstack-config --from-file=config=config.json --namespace crossplane
+```
 
 ```json
 // config.json
@@ -81,36 +75,79 @@ You can create the secret via this command:
 
 Check [Terraform OpenStack provider docs](https://registry.terraform.io/providers/terraform-provider-openstack/openstack/latest/docs#configuration-reference) to see available configuration settings. Currently not all options of the upstream provider are supported. Check [client code](https://github.com/crossplane-contrib/provider-openstack/blob/main/internal/clients/openstack.go#L66) to see if your option is supported. If something is missing, please open a new issue.
 
+
+### Deployment Customization
+
+You can use a `DeploymentRuntimeConfig` to provide custom arguments or otherwise modify the provider deployment
+
+Available command line arguments can be found [here](cmd/provider/main.go)
+
+```yaml
+---
+# Create a DeploymentRuntimeConfig to customize the provider deployment
+apiVersion: pkg.crossplane.io/v1beta1
+kind: DeploymentRuntimeConfig
+metadata:
+  name: provider-openstack
+spec:
+  deploymentTemplate:
+    spec:
+      # Control replica count to temporary disable deployment. Do not scale more than 1 replica.
+      replicas: 1
+      selector: {}
+      template:
+        metadata:
+          annotations:
+            # Add annotations, e.g. to enable metrics scraping
+            prometheus.io/path: /metrics
+            prometheus.io/port: "8080"
+            prometheus.io/scrape: "true"
+        spec:
+          containers:
+          - args:
+            # Add command line arguments, e.g. to enable management policies
+            - --enable-management-policies
+            name: package-runtime
+
+---
+# Add this to your provider resource to reference the DeploymentRuntimeConfig
+spec:
+  runtimeConfigRef:
+    apiVersion: pkg.crossplane.io/v1beta1
+    kind: DeploymentRuntimeConfig
+    name: provider-openstack
+```
+
 ## Developing
 
 Install the required submodules to build and run:
 
-```console
+```bash
 make submodules
 ```
 
 Apply the Current CRDs and a providerConfig:
 
-```console
+```bash
 kubectl apply -f package/crds
 kubectl apply -f examples/providerconfig/providerconfig.yaml
 ```
 
 Run against a Kubernetes cluster: (make sure to apply CRDs and providerConfig)
 
-```console
+```bash
 make run
 ```
 
 Run a testbuild with linting:
 
-```console
+```bash
 make reviewable
 ```
 
 Build binary:
 
-```console
+```bash
 make build
 ```