provider-petstore

module
v0.0.0-...-2bea0bf Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 16, 2022 License: Apache-2.0

README

provider-petstore

provider-petstore is a minimal Crossplane Provider that is meant to be used as a petstore for implementing new Providers. It comes with the following features that are meant to be refactored:

  • A ProviderConfig type that only points to a credentials Secret.
  • A MyType resource type that serves as an example managed resource.
  • A managed resource controller that reconciles MyType objects and simply prints their configuration in its Observe method.

Developing

  1. Use this repository as a petstore 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 follwing command:
  make provider.prepare provider={PascalProviderName}
  1. Add your new type by running the following command:
make provider.addtype provider={PascalProviderName} 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.

Directories

Path Synopsis
Package apis contains Kubernetes API for the PetStore provider.
Package apis contains Kubernetes API for the PetStore provider.
store
Package store contains group Store API versions
Package store contains group Store API versions
store/v1alpha1
Package v1alpha1 contains the v1alpha1 group Sample resources of the PetStore provider.
Package v1alpha1 contains the v1alpha1 group Sample resources of the PetStore provider.
v1alpha1
Package v1alpha1 contains the core resources of the PetStore provider.
Package v1alpha1 contains the core resources of the PetStore provider.
cmd
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳