pkg: github.com/knative/pkg/apis Index | Files | Directories

package apis

import "github.com/knative/pkg/apis"

+k8s:deepcopy-gen=package

Index

Package Files

condition_set.go condition_types.go contexts.go deprecated.go doc.go field_error.go interfaces.go kind2resource.go metadata_validation.go url.go volatile_time.go zz_generated.deepcopy.go

Constants

const (
    // CreatorAnnotationSuffix is the suffix of the annotation key to describe
    // the user that created the resource.
    CreatorAnnotationSuffix = "/creator"

    // UpdaterAnnotationSuffix is the suffix of the annotation key to describe
    // the user who last modified the resource.
    UpdaterAnnotationSuffix = "/lastModifier"
)
const CurrentField = ""

CurrentField is a constant to supply as a fieldPath for when there is a problem with the current field itself.

func DisallowDeprecated Uses

func DisallowDeprecated(ctx context.Context) context.Context

DisallowDeprecated notes on the context that further validation should disallow the used of deprecated fields. This may be used to ensure that new paths through resources to a common type don't allow the mistakes of old versions to be introduced.

func GetBaseline Uses

func GetBaseline(ctx context.Context) interface{}

GetBaseline returns the baseline of the update, or nil when we are not within an update context.

func GetUserInfo Uses

func GetUserInfo(ctx context.Context) *authenticationv1.UserInfo

GetUserInfo accesses the UserInfo attached to the webhook context.

func IsDeprecatedAllowed Uses

func IsDeprecatedAllowed(ctx context.Context) bool

IsDeprecatedAllowed checks the context to see whether deprecated fields are allowed.

func IsInCreate Uses

func IsInCreate(ctx context.Context) bool

IsInCreate checks whether the context is a Create.

func IsInSpec Uses

func IsInSpec(ctx context.Context) bool

IsInSpec returns whether the context of validation or defaulting is the Spec of the parent resource.

func IsInStatus Uses

func IsInStatus(ctx context.Context) bool

IsInStatus returns whether the context of validation or defaulting is the Status of the parent resource.

func IsInStatusUpdate Uses

func IsInStatusUpdate(ctx context.Context) bool

IsInStatusUpdate checks whether the context is an Update.

func IsInUpdate Uses

func IsInUpdate(ctx context.Context) bool

IsInUpdate checks whether the context is an Update.

func KindToResource Uses

func KindToResource(gvk schema.GroupVersionKind) schema.GroupVersionResource

KindToResource converts a GroupVersionKind to a GroupVersionResource through the world's simplest (worst) pluralizer.

func ParentMeta Uses

func ParentMeta(ctx context.Context) metav1.ObjectMeta

ParentMeta accesses the ObjectMeta of the enclosing parent resource from the context. See WithinParent for how to attach the parent's ObjectMeta to the context.

func WithUserInfo Uses

func WithUserInfo(ctx context.Context, ui *authenticationv1.UserInfo) context.Context

WithUserInfo is used to note that the webhook is calling within the context of a Create operation.

func WithinCreate Uses

func WithinCreate(ctx context.Context) context.Context

WithinCreate is used to note that the webhook is calling within the context of a Create operation.

func WithinParent Uses

func WithinParent(ctx context.Context, om metav1.ObjectMeta) context.Context

WithinParent attaches the ObjectMeta of the resource enclosing the nested resources we are validating. This is intended for use with interfaces like apis.Defaultable and apis.Validatable.

func WithinSpec Uses

func WithinSpec(ctx context.Context) context.Context

WithinSpec notes on the context that further validation or defaulting is within the context of a Spec. This is intended for use with interfaces like apis.Defaultable and apis.Validatable.

func WithinStatus Uses

func WithinStatus(ctx context.Context) context.Context

WithinStatus notes on the context that further validation or defaulting is within the context of a Status. This is intended for use with interfaces like apis.Defaultable and apis.Validatable.

func WithinSubResourceUpdate Uses

func WithinSubResourceUpdate(ctx context.Context, base interface{}, sr string) context.Context

WithinSubResourceUpdate is used to note that the webhook is calling within the context of a Update operation on a subresource.

func WithinUpdate Uses

func WithinUpdate(ctx context.Context, base interface{}) context.Context

WithinUpdate is used to note that the webhook is calling within the context of a Update operation.

type Annotatable Uses

type Annotatable interface{}

Annotatable indicates that a particular type applies various annotations. DEPRECATED: Use WithUserInfo / GetUserInfo from within SetDefaults instead. The webhook functionality for this has been turned down, which is why this interface is empty.

type Condition Uses

type Condition struct {
    // Type of condition.
    // +required
    Type ConditionType `json:"type" description:"type of status condition"`

    // Status of the condition, one of True, False, Unknown.
    // +required
    Status corev1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"`

    // Severity with which to treat failures of this type of condition.
    // When this is not specified, it defaults to Error.
    // +optional
    Severity ConditionSeverity `json:"severity,omitempty" description:"how to interpret failures of this condition, one of Error, Warning, Info"`

    // LastTransitionTime is the last time the condition transitioned from one status to another.
    // We use VolatileTime in place of metav1.Time to exclude this from creating equality.Semantic
    // differences (all other things held constant).
    // +optional
    LastTransitionTime VolatileTime `json:"lastTransitionTime,omitempty" description:"last time the condition transit from one status to another"`

    // The reason for the condition's last transition.
    // +optional
    Reason string `json:"reason,omitempty" description:"one-word CamelCase reason for the condition's last transition"`

    // A human readable message indicating details about the transition.
    // +optional
    Message string `json:"message,omitempty" description:"human-readable message indicating details about last transition"`
}

Conditions defines a readiness condition for a Knative resource. See: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#typical-status-properties +k8s:deepcopy-gen=true +k8s:openapi-gen=true

func (*Condition) DeepCopy Uses

func (in *Condition) DeepCopy() *Condition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Condition.

func (*Condition) DeepCopyInto Uses

func (in *Condition) DeepCopyInto(out *Condition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Condition) IsFalse Uses

func (c *Condition) IsFalse() bool

IsFalse is true if the condition is False

func (*Condition) IsTrue Uses

func (c *Condition) IsTrue() bool

IsTrue is true if the condition is True

func (*Condition) IsUnknown Uses

func (c *Condition) IsUnknown() bool

IsUnknown is true if the condition is Unknown

type ConditionManager Uses

type ConditionManager interface {
    // IsHappy looks at the happy condition and returns true if that condition is
    // set to true.
    IsHappy() bool

    // GetCondition finds and returns the Condition that matches the ConditionType
    // previously set on Conditions.
    GetCondition(t ConditionType) *Condition

    // SetCondition sets or updates the Condition on Conditions for Condition.Type.
    // If there is an update, Conditions are stored back sorted.
    SetCondition(new Condition)

    // ClearCondition removes the non terminal condition that matches the ConditionType
    ClearCondition(t ConditionType) error

    // MarkTrue sets the status of t to true, and then marks the happy condition to
    // true if all dependents are true.
    MarkTrue(t ConditionType)

    // MarkUnknown sets the status of t to Unknown and also sets the happy condition
    // to Unknown if no other dependent condition is in an error state.
    MarkUnknown(t ConditionType, reason, messageFormat string, messageA ...interface{})

    // MarkFalse sets the status of t and the happy condition to False.
    MarkFalse(t ConditionType, reason, messageFormat string, messageA ...interface{})

    // InitializeConditions updates all Conditions in the ConditionSet to Unknown
    // if not set.
    InitializeConditions()
}

ConditionManager allows a resource to operate on its Conditions using higher order operations.

type ConditionSet Uses

type ConditionSet struct {
    // contains filtered or unexported fields
}

ConditionSet is an abstract collection of the possible ConditionType values that a particular resource might expose. It also holds the "happy condition" for that resource, which we define to be one of Ready or Succeeded depending on whether it is a Living or Batch process respectively. +k8s:deepcopy-gen=false

func NewBatchConditionSet Uses

func NewBatchConditionSet(d ...ConditionType) ConditionSet

NewBatchConditionSet returns a ConditionSet to hold the conditions for the batch resource. ConditionSucceeded is used as the happy condition. The set of condition types provided are those of the terminal subconditions.

func NewLivingConditionSet Uses

func NewLivingConditionSet(d ...ConditionType) ConditionSet

NewLivingConditionSet returns a ConditionSet to hold the conditions for the living resource. ConditionReady is used as the happy condition. The set of condition types provided are those of the terminal subconditions.

func (ConditionSet) Manage Uses

func (r ConditionSet) Manage(status ConditionsAccessor) ConditionManager

Manage creates a ConditionManager from an accessor object using the original ConditionSet as a reference. Status must be a pointer to a struct.

type ConditionSeverity Uses

type ConditionSeverity string

ConditionSeverity expresses the severity of a Condition Type failing.

const (
    // ConditionSeverityError specifies that a failure of a condition type
    // should be viewed as an error.  As "Error" is the default for conditions
    // we use the empty string (coupled with omitempty) to avoid confusion in
    // the case where the condition is in state "True" (aka nothing is wrong).
    ConditionSeverityError ConditionSeverity = ""
    // ConditionSeverityWarning specifies that a failure of a condition type
    // should be viewed as a warning, but that things could still work.
    ConditionSeverityWarning ConditionSeverity = "Warning"
    // ConditionSeverityInfo specifies that a failure of a condition type
    // should be viewed as purely informational, and that things could still work.
    ConditionSeverityInfo ConditionSeverity = "Info"
)

type ConditionType Uses

type ConditionType string

ConditionType is a camel-cased condition type.

const (
    // ConditionReady specifies that the resource is ready.
    // For long-running resources.
    ConditionReady ConditionType = "Ready"
    // ConditionSucceeded specifies that the resource has finished.
    // For resource which run to completion.
    ConditionSucceeded ConditionType = "Succeeded"
)

type Conditions Uses

type Conditions []Condition

Conditions is the schema for the conditions portion of the payload

func (Conditions) DeepCopy Uses

func (in Conditions) DeepCopy() Conditions

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Conditions.

func (Conditions) DeepCopyInto Uses

func (in Conditions) DeepCopyInto(out *Conditions)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConditionsAccessor Uses

type ConditionsAccessor interface {
    GetConditions() Conditions
    SetConditions(Conditions)
}

Conditions is the interface for a Resource that implements the getter and setter for accessing a Condition collection. +k8s:deepcopy-gen=true

type Convertible Uses

type Convertible interface {
    // ConvertUp up-converts the receiver into `to`.
    ConvertUp(ctx context.Context, to Convertible) error

    // ConvertDown down-converts from `from` into the receiver.
    ConvertDown(ctx context.Context, from Convertible) error
}

Convertible indicates that a particular type supports conversions to/from "higher" versions of the same type.

type Defaultable Uses

type Defaultable interface {
    SetDefaults(context.Context)
}

Defaultable defines an interface for setting the defaults for the uninitialized fields of this instance.

type FieldError Uses

type FieldError struct {
    Message string
    Paths   []string
    // Details contains an optional longer payload.
    // +optional
    Details string
    // contains filtered or unexported fields
}

FieldError is used to propagate the context of errors pertaining to specific fields in a manner suitable for use in a recursive walk, so that errors contain the appropriate field context. FieldError methods are non-mutating. +k8s:deepcopy-gen=true

func CheckDeprecated Uses

func CheckDeprecated(ctx context.Context, obj interface{}) *FieldError

CheckDeprecated checks whether the provided named deprecated fields are set in a context where deprecation is disallowed. This is a shallow check.

func CheckDeprecatedUpdate Uses

func CheckDeprecatedUpdate(ctx context.Context, obj interface{}, original interface{}) *FieldError

CheckDeprecated checks whether the provided named deprecated fields are set in a context where deprecation is disallowed. This is a json shallow check. We will recursively check inlined structs.

func CheckDisallowedFields Uses

func CheckDisallowedFields(request, maskedRequest interface{}) *FieldError

CheckDisallowedFields compares the request object against a masked request object. Fields that are set in the request object that are unset in the mask are reported back as disallowed fields. If there is an error comparing the two objects FieldError of "Internal Error" is returned.

func ErrDisallowedFields Uses

func ErrDisallowedFields(fieldPaths ...string) *FieldError

ErrDisallowedFields is a variadic helper method for constructing a FieldError for a set of disallowed fields.

func ErrDisallowedUpdateDeprecatedFields Uses

func ErrDisallowedUpdateDeprecatedFields(fieldPaths ...string) *FieldError

ErrDisallowedUpdateDeprecatedFields is a variadic helper method for constructing a FieldError for updating of deprecated fields.

func ErrInvalidArrayValue Uses

func ErrInvalidArrayValue(value interface{}, field string, index int) *FieldError

ErrInvalidArrayValue constructs a FieldError for a repetetive `field` at `index` that has received an invalid string value.

func ErrInvalidKeyName Uses

func ErrInvalidKeyName(key, fieldPath string, details ...string) *FieldError

ErrInvalidKeyName is a variadic helper method for constructing a FieldError that specifies a key name that is invalid.

func ErrInvalidValue Uses

func ErrInvalidValue(value interface{}, fieldPath string) *FieldError

ErrInvalidValue constructs a FieldError for a field that has received an invalid string value.

func ErrMissingField Uses

func ErrMissingField(fieldPaths ...string) *FieldError

ErrMissingField is a variadic helper method for constructing a FieldError for a set of missing fields.

func ErrMissingOneOf Uses

func ErrMissingOneOf(fieldPaths ...string) *FieldError

ErrMissingOneOf is a variadic helper method for constructing a FieldError for not having at least one field in a mutually exclusive field group.

func ErrMultipleOneOf Uses

func ErrMultipleOneOf(fieldPaths ...string) *FieldError

ErrMultipleOneOf is a variadic helper method for constructing a FieldError for having more than one field set in a mutually exclusive field group.

func ErrOutOfBoundsValue Uses

func ErrOutOfBoundsValue(value, lower, upper interface{}, fieldPath string) *FieldError

ErrOutOfBoundsValue constructs a FieldError for a field that has received an out of bound value.

func ValidateCreatorAndModifier Uses

func ValidateCreatorAndModifier(oldSpec, newSpec interface{}, oldAnnotation, newAnnotation map[string]string, groupName string) *FieldError

ValidateCreatorAndModifier validates `metadata.annotation`

func ValidateObjectMetadata Uses

func ValidateObjectMetadata(meta metav1.Object) *FieldError

ValidateObjectMetadata validates that `metadata` stanza of the resources is correct.

func (*FieldError) Also Uses

func (fe *FieldError) Also(errs ...*FieldError) *FieldError

Also collects errors, returns a new collection of existing errors and new errors.

func (*FieldError) DeepCopy Uses

func (in *FieldError) DeepCopy() *FieldError

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FieldError.

func (*FieldError) DeepCopyInto Uses

func (in *FieldError) DeepCopyInto(out *FieldError)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*FieldError) Error Uses

func (fe *FieldError) Error() string

Error implements error

func (*FieldError) ViaField Uses

func (fe *FieldError) ViaField(prefix ...string) *FieldError

ViaField is used to propagate a validation error along a field access. For example, if a type recursively validates its "spec" via:

if err := foo.Spec.Validate(); err != nil {
  // Augment any field paths with the context that they were accessed
  // via "spec".
  return err.ViaField("spec")
}

func (*FieldError) ViaFieldIndex Uses

func (fe *FieldError) ViaFieldIndex(field string, index int) *FieldError

ViaFieldIndex is the short way to chain: err.ViaIndex(bar).ViaField(foo)

func (*FieldError) ViaFieldKey Uses

func (fe *FieldError) ViaFieldKey(field string, key string) *FieldError

ViaFieldKey is the short way to chain: err.ViaKey(bar).ViaField(foo)

func (*FieldError) ViaIndex Uses

func (fe *FieldError) ViaIndex(index int) *FieldError

ViaIndex is used to attach an index to the next ViaField provided. For example, if a type recursively validates a parameter that has a collection:

for i, c := range spec.Collection {
  if err := doValidation(c); err != nil {
    return err.ViaIndex(i).ViaField("collection")
  }
}

func (*FieldError) ViaKey Uses

func (fe *FieldError) ViaKey(key string) *FieldError

ViaKey is used to attach a key to the next ViaField provided. For example, if a type recursively validates a parameter that has a collection:

for k, v := range spec.Bag {
  if err := doValidation(v); err != nil {
    return err.ViaKey(k).ViaField("bag")
  }
}

type HasSpec Uses

type HasSpec interface {
    // GetUntypedSpec returns the spec of the resource.
    GetUntypedSpec() interface{}
}

HasSpec indicates that a particular type has a specification information and that information is retrievable.

type Immutable Uses

type Immutable interface {
    // CheckImmutableFields checks that the current instance's immutable
    // fields haven't changed from the provided original.
    CheckImmutableFields(ctx context.Context, original Immutable) *FieldError
}

Immutable indicates that a particular type has fields that should not change after creation. DEPRECATED: Use WithinUpdate / GetBaseline from within Validatable instead.

type Listable Uses

type Listable interface {
    runtime.Object

    GetListType() runtime.Object
}

Listable indicates that a particular type can be returned via the returned list type by the API server.

type URL Uses

type URL url.URL

URL is an alias of url.URL. It has custom json marshal methods that enable it to be used in K8s CRDs such that the CRD resource will have the URL but operator code can can work with url.URL struct

func ParseURL Uses

func ParseURL(u string) (*URL, error)

ParseURL attempts to parse the given string as a URL. Compatible with net/url.Parse except in the case of an empty string, where the resulting *URL will be nil with no error.

func (*URL) DeepCopy Uses

func (in *URL) DeepCopy() *URL

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new URL.

func (*URL) DeepCopyInto Uses

func (in *URL) DeepCopyInto(out *URL)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (URL) MarshalJSON Uses

func (u URL) MarshalJSON() ([]byte, error)

MarshalJSON implements a custom json marshal method used when this type is marshaled using json.Marshal. json.Marshaler impl

func (*URL) String Uses

func (u *URL) String() string

String returns the full string representation of the URL.

func (*URL) UnmarshalJSON Uses

func (u *URL) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the json unmarshal method used when this type is unmarsheled using json.Unmarshal. json.Unmarshaler impl

type Validatable Uses

type Validatable interface {
    // Validate checks the validity of this types fields.
    Validate(context.Context) *FieldError
}

Validatable indicates that a particular type may have its fields validated.

type VolatileTime Uses

type VolatileTime struct {
    Inner metav1.Time
}

VolatileTime wraps metav1.Time +k8s:openapi-gen=true

func (*VolatileTime) DeepCopy Uses

func (in *VolatileTime) DeepCopy() *VolatileTime

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolatileTime.

func (*VolatileTime) DeepCopyInto Uses

func (in *VolatileTime) DeepCopyInto(out *VolatileTime)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (VolatileTime) MarshalJSON Uses

func (t VolatileTime) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (*VolatileTime) UnmarshalJSON Uses

func (t *VolatileTime) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the json.Unmarshaller interface.

Directories

PathSynopsis
duckPackage duck defines logic for defining and consuming "duck typed" Kubernetes resources.
duck/v1alpha1
duck/v1beta1
istio
istio/authentication
istio/authentication/v1alpha1Api versions allow the api contract for a resource to be changed while keeping backward compatibility by support multiple concurrent versions of the same resource +k8s:deepcopy-gen=package +groupName=authentication.istio.io
istio/common/v1alpha1
istio/v1alpha3
testing
v1alpha1

Package apis imports 16 packages (graph) and is imported by 31 packages. Updated 2019-08-16. Refresh now. Tools for package owners.