v1

Documentation

Overview

+groupName=datasciencecluster.opendatahub.io

Index

• type AuthSpec
  • func (in *AuthSpec) DeepCopy() *AuthSpec
  • func (in *AuthSpec) DeepCopyInto(out *AuthSpec)
• type CertType
• type CertificateSpec
  • func (in *CertificateSpec) DeepCopy() *CertificateSpec
  • func (in *CertificateSpec) DeepCopyInto(out *CertificateSpec)
• type ControlPlaneSpec
  • func (in *ControlPlaneSpec) DeepCopy() *ControlPlaneSpec
  • func (in *ControlPlaneSpec) DeepCopyInto(out *ControlPlaneSpec)
• type GatewaySpec
  • func (in *GatewaySpec) DeepCopy() *GatewaySpec
  • func (in *GatewaySpec) DeepCopyInto(out *GatewaySpec)
• type ServiceMeshSpec
  • func (in *ServiceMeshSpec) DeepCopy() *ServiceMeshSpec
  • func (in *ServiceMeshSpec) DeepCopyInto(out *ServiceMeshSpec)
• type ServingSpec
  • func (in *ServingSpec) DeepCopy() *ServingSpec
  • func (in *ServingSpec) DeepCopyInto(out *ServingSpec)

Types

type AuthSpec

type AuthSpec struct {
	// Namespace where it is deployed. If not provided, the default is to
	// use '-auth-provider' suffix on the ApplicationsNamespace of the DSCI.
	Namespace string `json:"namespace,omitempty"`
	// Audiences is a list of the identifiers that the resource server presented
	// with the token identifies as. Audience-aware token authenticators will verify
	// that the token was intended for at least one of the audiences in this list.
	// If no audiences are provided, the audience will default to the audience of the
	// Kubernetes apiserver (kubernetes.default.svc).
	// +kubebuilder:default={"https://kubernetes.default.svc"}
	Audiences *[]string `json:"audiences,omitempty"`
}

func (*AuthSpec) DeepCopy

func (in *AuthSpec) DeepCopy() *AuthSpec

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

func (*AuthSpec) DeepCopyInto

func (in *AuthSpec) DeepCopyInto(out *AuthSpec)

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

type CertType

type CertType string

const (
	SelfSigned              CertType = "SelfSigned"
	Provided                CertType = "Provided"
	OpenshiftDefaultIngress CertType = "OpenshiftDefaultIngress"
)

type CertificateSpec

type CertificateSpec struct {
	// SecretName specifies the name of the Kubernetes Secret resource that contains a
	// TLS certificate secure HTTP communications for the KNative network.
	SecretName string `json:"secretName,omitempty"`
	// Type specifies if the TLS certificate should be generated automatically, or if the certificate
	// is provided by the user. Allowed values are:
	// * SelfSigned: A certificate is going to be generated using an own private key.
	// * Provided: Pre-existence of the TLS Secret (see SecretName) with a valid certificate is assumed.
	// * OpenshiftDefaultIngress: Default ingress certificate configured for OpenShift
	// +kubebuilder:validation:Enum=SelfSigned;Provided;OpenshiftDefaultIngress
	// +kubebuilder:default=OpenshiftDefaultIngress
	Type CertType `json:"type,omitempty"`
}

CertificateSpec represents the specification of the certificate securing communications of an Istio Gateway.

func (*CertificateSpec) DeepCopy

func (in *CertificateSpec) DeepCopy() *CertificateSpec

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

func (*CertificateSpec) DeepCopyInto

func (in *CertificateSpec) DeepCopyInto(out *CertificateSpec)

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

type ControlPlaneSpec

type ControlPlaneSpec struct {
	// Name is a name Service Mesh Control Plane. Defaults to "data-science-smcp".
	// +kubebuilder:default=data-science-smcp
	Name string `json:"name,omitempty"`
	// Namespace is a namespace where Service Mesh is deployed. Defaults to "istio-system".
	// +kubebuilder:default=istio-system
	Namespace string `json:"namespace,omitempty"`
	// MetricsCollection specifies if metrics from components on the Mesh namespace
	// should be collected. Setting the value to "Istio" will collect metrics from the
	// control plane and any proxies on the Mesh namespace (like gateway pods). Setting
	// to "None" will disable metrics collection.
	// +kubebuilder:validation:Enum=Istio;None
	// +kubebuilder:default=Istio
	MetricsCollection string `json:"metricsCollection,omitempty"`
}

func (*ControlPlaneSpec) DeepCopy

func (in *ControlPlaneSpec) DeepCopy() *ControlPlaneSpec

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

func (*ControlPlaneSpec) DeepCopyInto

func (in *ControlPlaneSpec) DeepCopyInto(out *ControlPlaneSpec)

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

type GatewaySpec

type GatewaySpec struct {
	// Domain specifies the host name for intercepting incoming requests.
	// Most likely, you will want to use a wildcard name, like *.example.com.
	// If not set, the domain of the OpenShift Ingress is used.
	// If you choose to generate a certificate, this is the domain used for the certificate request.
	Domain string `json:"domain,omitempty"`
	// Certificate specifies configuration of the TLS certificate securing communication
	// for the gateway.
	Certificate CertificateSpec `json:"certificate,omitempty"`
}

GatewaySpec represents the configuration of the Ingress Gateways.

func (*GatewaySpec) DeepCopy

func (in *GatewaySpec) DeepCopy() *GatewaySpec

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

func (*GatewaySpec) DeepCopyInto

func (in *GatewaySpec) DeepCopyInto(out *GatewaySpec)

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

type ServiceMeshSpec

type ServiceMeshSpec struct {
	// +kubebuilder:validation:Enum=Managed;Unmanaged;Removed
	// +kubebuilder:default=Removed
	ManagementState operatorv1.ManagementState `json:"managementState,omitempty"`
	// ControlPlane holds configuration of Service Mesh used by Opendatahub.
	ControlPlane ControlPlaneSpec `json:"controlPlane,omitempty"`
	// Auth holds configuration of authentication and authorization services
	// used by Service Mesh in Opendatahub.
	Auth AuthSpec `json:"auth,omitempty"`
}

ServiceMeshSpec configures Service Mesh.

func (*ServiceMeshSpec) DeepCopy

func (in *ServiceMeshSpec) DeepCopy() *ServiceMeshSpec

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

func (*ServiceMeshSpec) DeepCopyInto

func (in *ServiceMeshSpec) DeepCopyInto(out *ServiceMeshSpec)

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

type ServingSpec

type ServingSpec struct {
	// +kubebuilder:validation:Enum=Managed;Unmanaged;Removed
	// +kubebuilder:default=Managed
	ManagementState operatorv1.ManagementState `json:"managementState,omitempty"`
	// Name specifies the name of the KNativeServing resource that is going to be
	// created to instruct the KNative Operator to deploy KNative serving components.
	// This resource is created in the "knative-serving" namespace.
	// +kubebuilder:default=knative-serving
	Name string `json:"name,omitempty"`
	// IngressGateway allows to customize some parameters for the Istio Ingress Gateway
	// that is bound to KNative-Serving.
	IngressGateway GatewaySpec `json:"ingressGateway,omitempty"`
}

ServingSpec specifies the configuration for the KNative Serving components and their bindings with the Service Mesh.

func (*ServingSpec) DeepCopy

func (in *ServingSpec) DeepCopy() *ServingSpec

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

func (*ServingSpec) DeepCopyInto

func (in *ServingSpec) DeepCopyInto(out *ServingSpec)

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