Documentation
¶
Index ¶
- Variables
- type Client
- func (c *Client) Create(ctx context.Context, request *generated.ControlPlane) error
- func (c *Client) Delete(ctx context.Context, name generated.ControlPlaneNameParameter) error
- func (c *Client) Get(ctx context.Context, name generated.ControlPlaneNameParameter) (*generated.ControlPlane, error)
- func (c *Client) GetMetadata(ctx context.Context, name string) (*Meta, error)
- func (c *Client) GetOrCreateMetadata(ctx context.Context, name string) (*Meta, error)
- func (c *Client) List(ctx context.Context) ([]*generated.ControlPlane, error)
- func (c *Client) Update(ctx context.Context, name generated.ControlPlaneNameParameter, ...) error
- type Meta
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrResourceDeleting is raised when the resource is being deleted. ErrResourceDeleting = goerrors.New("resource is being deleted") // ErrNamespaceUnset is raised when the namespace hasn't been created // yet. ErrNamespaceUnset = goerrors.New("resource namespace is unset") // ErrApplicationBundle is raised when no suitable application // bundle is found. ErrApplicationBundle = goerrors.New("no application bundle found") )
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client wraps up control plane related management handling.
func (*Client) Get ¶
func (c *Client) Get(ctx context.Context, name generated.ControlPlaneNameParameter) (*generated.ControlPlane, error)
Get returns the control plane.
func (*Client) GetMetadata ¶
GetMetadata retrieves the control plane metadata.
func (*Client) GetOrCreateMetadata ¶
func (*Client) Update ¶
func (c *Client) Update(ctx context.Context, name generated.ControlPlaneNameParameter, request *generated.ControlPlane) error
Update implements read/modify/write for the control plane.
type Meta ¶
type Meta struct {
// Project is the owning project's metadata.
Project *project.Meta
// Name is the project's Kubernetes name, so a higher level resource
// can reference it.
Name string
// Namespace is the namespace that is provisioned by the control plane.
// Should be usable and set when the project is active.
Namespace string
// Deleting tells us if we should allow new child objects to be created
// in this resource's namespace.
Deleting bool
}
Meta describes the control plane.
Source Files
Click to show internal directories.
Click to hide internal directories.