porch

Documentation

Overview

Copyright 2022 The kpt and Nephio Authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

porch contains utilities and shared functionality supporting the package orchestration commands

Index

• Constants
• func Apply(ctx context.Context, api client.Client, obj client.Object) error
• func CreateClient(config *rest.Config) (client.Client, error)
• func CreateClientWithFlags(flags *genericclioptions.ConfigFlags) (client.Client, error)
• func CreateDynamicClient(flags *genericclioptions.ConfigFlags) (client.WithWatch, error)
• func CreateRESTClient(flags *genericclioptions.ConfigFlags) (rest.Interface, error)
• func LastSegment(path string) string
• func ToShortNames(functions []v1alpha1.Function) []string
• func UnifyKeywords(functions []v1alpha1.Function) []string
• func UpdatePackageRevisionApproval(ctx context.Context, client client.Client, key client.ObjectKey, ...) error
• type FunctionGetter
  • func (f FunctionGetter) Get(ctx context.Context, name, namespace string) (v1alpha1.Function, error)
• type FunctionListGetter
  • func (f FunctionListGetter) Get(ctx context.Context) []v1alpha1.Function

Constants

const Expiration time.Duration = 10 * time.Second

const HidePorchCommands = false

Controls whether the Package Orchestration CLI commands are hidden.

Functions

func Apply

func Apply(ctx context.Context, api client.Client, obj client.Object) error

func CreateClient

func CreateClient(config *rest.Config) (client.Client, error)

func CreateClientWithFlags

func CreateClientWithFlags(flags *genericclioptions.ConfigFlags) (client.Client, error)

func CreateDynamicClient

func CreateDynamicClient(flags *genericclioptions.ConfigFlags) (client.WithWatch, error)

func CreateRESTClient

func CreateRESTClient(flags *genericclioptions.ConfigFlags) (rest.Interface, error)

controller-runtime does not support subresources so we use REST client directly. TODO: Separate Porch clientset into its own module (similar to k8s clientsets) to use it without causing circular reference.

func LastSegment

func LastSegment(path string) string

func ToShortNames

func ToShortNames(functions []v1alpha1.Function) []string

func UnifyKeywords

func UnifyKeywords(functions []v1alpha1.Function) []string

func UpdatePackageRevisionApproval

func UpdatePackageRevisionApproval(ctx context.Context, client client.Client, key client.ObjectKey, new v1alpha1.PackageRevisionLifecycle) error

Types

type FunctionGetter

type FunctionGetter struct{}

FunctionGetter gets a specific v1alpha1.Functions by name.

func (FunctionGetter) Get

func (f FunctionGetter) Get(ctx context.Context, name, namespace string) (v1alpha1.Function, error)

type FunctionListGetter

type FunctionListGetter struct{}

FunctionListGetter gets the list of v1alpha1.Functions from the cluster.

func (FunctionListGetter) Get

func (f FunctionListGetter) Get(ctx context.Context) []v1alpha1.Function