provider-tempoplane

README

Provider tempoplane

Provider for Crossplane to manage and orchestrate Temporal-based workflows using Tempoplane.

Features

• Manage workflows as Crossplane custom resources.
• Observe, create, update, and delete workflows from Kubernetes.

Usage

1. Install Crossplane.
2. Deploy the provider-tempoplane.
3. Define EntityWorkflow custom resources to manage your workflows.
4. Configure your worker via https://github.com/daanvinken/tempoplane

Developing

1. Use this repository as a tempoplane to create a new one.
2. Run make submodules to initialize the "build" Make submodule we use for CI/CD.
3. Rename the provider by running the following command:

  export provider_name=MyProvider # Camel case, e.g. GitHub
  make provider.prepare provider=${provider_name}

1. Add your new type by running the following command:

  export group=sample # lower case e.g. core, cache, database, storage, etc.
  export type=MyType # Camel casee.g. Bucket, Database, CacheCluster, etc.
  make provider.addtype provider=${provider_name} group=${group} kind=${type}

1. Replace the sample group with your new group in apis/{provider}.go
2. Replace the mytype type with your new type in internal/controller/{provider}.go
3. Replace the default controller and ProviderConfig implementations with your own
4. Run make reviewable to run code generation, linters, and tests.
5. Run make build to build the provider.

Refer to Crossplane's CONTRIBUTING.md file for more information on how the Crossplane community prefers to work. The Provider Development guide may also be of use.