morningspace/capabilities-shim

A reference implementation to compose existing software capabilities using Crossplane.

Hi there 👋

At any time, you can find out more about me by visiting:

• morningspace.github.io.
• morningspace.medium.com
• linkedin

capabilities-shim's Issues

Docs to summarize the idea, design and implementation

Consider UI-based install

Create a script for env preparation

Steps:

• Launch kind
• Preload docker images
• Install Crossplane
• Install OLM
• Install ODLM
• Install capabilities Configuration package
• Setup ProviderConfig and cluster-config secret

Tooling for nested composition authoring

Add more scenarios for capabilities orchestration

• Add more backends used to provision actual workloads, e.g: Helm, Ansible, Terraform;
• Compose capabilities across multiple backends, e.g.: to mix capabilities from Helm-based stuff and OLM-based stuff;
• Compose capabilities across multiple deployments (clusters), e.g.: to mix capabilities from two separate clusters;

TODOs for initial implementation

• Cluster scope vs. Namespace scope for MR
  Consider using provider-kubernetes.

• How to avoid apply RBAC settings manually?
  Minimized the RBAC applying, only RBAC for objects at cluster scoped needed

• How to reflect the raw Kubernetes resource status at Object level?
  This can be retrieved by getting .status.atProvider at Object level

• How to clean up resources when uninstall XR claim?
  Consider apply annotation in provider or composition for existing object. For example, CSV is created after Subscription is created. Only Subscription is managed by the provider as MR. How to know the corresponding CSV to be deleted while Subscription is deleted by deleting the XRC? (Use ODLM)

• Install ODLM and test

• How to ensure install order for multiple MRs?
  Also the reverse order when uninstall. This is needed in some cases although generally it is nice to have due to the reconciliation nature supported by Kubernetes. However, especially, for uninstall case, some objects may fail to be deleted because their prereqs are deleted to early. (ODLM uninstall issue has been fixed)

• Find and patch existing arbitrary Kubernetes resource rather than create new one. (The CSV case)

• During uninstall, in some cases, the dependencies may be failed to resolve in Observe which breaks the object to be deleted.

• Composition refactoring

• Select among multiple compositions

• Composition for all caps

• Code refactoring

• Build package

Document: getting started

Instructions:

• Apply networking capability
• Verify installation
• Apply logging capability
• Verify installation
• Apply all capabilities
• Verify installation