cdk8smetaflow

package module
v0.0.6 Latest Latest
Warning

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

 Go to latest Published: Aug 5, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

README

cdk8s-metaflow

Collection of cdk8s constructs for deploying Metaflow on Kubernetes.

Imports
cdk8s import k8s@1.22.0 -l typescript -o src/imports
cdk8s import github:minio/operator@4.4.22 -l typescript -o src/imports

Documentation

Overview

cdk8s-metaflow

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func MetadataDatabase_IsConstruct added in v0.0.3 

func MetadataDatabase_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`. Experimental.

func MetaflowService_IsConstruct 

func MetaflowService_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`. Experimental.

func MetaflowUI_IsConstruct added in v0.0.3 

func MetaflowUI_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`. Experimental.

func NewMetadataDatabase_Override added in v0.0.3 

func NewMetadataDatabase_Override(m MetadataDatabase, scope constructs.Construct, id *string, props *MetadataDatabaseProps)

Experimental.

func NewMetaflowService_Override 

func NewMetaflowService_Override(m MetaflowService, scope constructs.Construct, id *string, props *MetaflowServiceProps)

Experimental.

func NewMetaflowUI_Override added in v0.0.3 

func NewMetaflowUI_Override(m MetaflowUI, scope constructs.Construct, id *string, props *MetaflowUIProps)

Experimental.

Types

type AutoscalingOptions added in v0.0.3 

type AutoscalingOptions struct {
	// Experimental.
	Enabled *bool `field:"optional" json:"enabled" yaml:"enabled"`
	// Experimental.
	MaxReplicas *float64 `field:"optional" json:"maxReplicas" yaml:"maxReplicas"`
	// Experimental.
	MinReplicas *float64 `field:"optional" json:"minReplicas" yaml:"minReplicas"`
	// Experimental.
	TargetCPUUtilizationPercentage *float64 `field:"optional" json:"targetCPUUtilizationPercentage" yaml:"targetCPUUtilizationPercentage"`
}

Experimental.

type DatabaseAuthOptions added in v0.0.3 

type DatabaseAuthOptions struct {
	// Experimental.
	Database *string `field:"optional" json:"database" yaml:"database"`
	// Experimental.
	EnablePostgresUser *bool `field:"optional" json:"enablePostgresUser" yaml:"enablePostgresUser"`
	// Experimental.
	Password *string `field:"optional" json:"password" yaml:"password"`
	// Experimental.
	PostgresPassword *string `field:"optional" json:"postgresPassword" yaml:"postgresPassword"`
	// Experimental.
	ReplicationPassword *string `field:"optional" json:"replicationPassword" yaml:"replicationPassword"`
	// Experimental.
	ReplicationUsername *string `field:"optional" json:"replicationUsername" yaml:"replicationUsername"`
	// Experimental.
	Username *string `field:"optional" json:"username" yaml:"username"`
}

Experimental.

type DatabaseMetricsOptions added in v0.0.3 

type DatabaseMetricsOptions struct {
	// Experimental.
	Enabled *bool `field:"optional" json:"enabled" yaml:"enabled"`
}

Experimental.

type DatabaseReplicationOptions added in v0.0.3 

type DatabaseReplicationOptions struct {
	// Experimental.
	Enabled *bool `field:"optional" json:"enabled" yaml:"enabled"`
	// Experimental.
	ReadReplicas *float64 `field:"optional" json:"readReplicas" yaml:"readReplicas"`
}

Experimental.

type DatabaseResourceRequestOptions added in v0.0.3 

type DatabaseResourceRequestOptions struct {
	// Experimental.
	Cpu *string `field:"optional" json:"cpu" yaml:"cpu"`
	// Experimental.
	Memory *string `field:"optional" json:"memory" yaml:"memory"`
}

Experimental.

type DatabaseResourcesOptions added in v0.0.3 

type DatabaseResourcesOptions struct {
	// Experimental.
	Requests *DatabaseResourceRequestOptions `field:"optional" json:"requests" yaml:"requests"`
}

Experimental.

type DatabaseVolumePermissionsOptions added in v0.0.3 

type DatabaseVolumePermissionsOptions struct {
	// Experimental.
	Enabled *bool `field:"optional" json:"enabled" yaml:"enabled"`
}

Experimental.

type DbMigrationOptions added in v0.0.3 

type DbMigrationOptions struct {
	// Experimental.
	OnlyIfDbEmpty *bool `field:"optional" json:"onlyIfDbEmpty" yaml:"onlyIfDbEmpty"`
	// Experimental.
	RunOnStart *bool `field:"optional" json:"runOnStart" yaml:"runOnStart"`
}

Experimental.

type HostOptions added in v0.0.3 

type HostOptions struct {
	// Experimental.
	Host *string `field:"optional" json:"host" yaml:"host"`
	// Experimental.
	Paths *[]*HttpIngressPath `field:"optional" json:"paths" yaml:"paths"`
}

Experimental.

type HttpIngressPath added in v0.0.3 

type HttpIngressPath struct {
	// Experimental.
	Path *string `field:"optional" json:"path" yaml:"path"`
	// Experimental.
	PathType HttpIngressPathType `field:"optional" json:"pathType" yaml:"pathType"`
}

Experimental.

type HttpIngressPathType added in v0.0.3 

type HttpIngressPathType string

Experimental. 

const (
	// Experimental.
	HttpIngressPathType_PREFIX HttpIngressPathType = "PREFIX"
	// Experimental.
	HttpIngressPathType_EXACT HttpIngressPathType = "EXACT"
	// Experimental.
	HttpIngressPathType_IMPLEMENTATION_SPECIFIC HttpIngressPathType = "IMPLEMENTATION_SPECIFIC"
)

type IApiResource added in v0.0.3 

type IApiResource interface {
	// Experimental.
	ApiGroup() *string
	// Experimental.
	ResourceName() *string
	// Experimental.
	ResourceType() *string
}

Experimental.

type ImageOptions added in v0.0.3 

type ImageOptions struct {
	// Experimental.
	PullPolicy ImagePullPolicy `field:"optional" json:"pullPolicy" yaml:"pullPolicy"`
	// Experimental.
	Repository *string `field:"optional" json:"repository" yaml:"repository"`
	// Experimental.
	Tag *string `field:"optional" json:"tag" yaml:"tag"`
}

Experimental.

type ImagePullPolicy added in v0.0.3 

type ImagePullPolicy string

Experimental. 

const (
	// Experimental.
	ImagePullPolicy_ALWAYS ImagePullPolicy = "ALWAYS"
	// Experimental.
	ImagePullPolicy_IF_NOT_PRESENT ImagePullPolicy = "IF_NOT_PRESENT"
	// Experimental.
	ImagePullPolicy_NEVER ImagePullPolicy = "NEVER"
)

type IngressOptions 

type IngressOptions struct {
	// Experimental.
	Annotations *map[string]*string `field:"optional" json:"annotations" yaml:"annotations"`
	// Experimental.
	ClassName *string `field:"optional" json:"className" yaml:"className"`
	// Experimental.
	Enabled *bool `field:"optional" json:"enabled" yaml:"enabled"`
	// Experimental.
	Hosts *[]*HostOptions `field:"optional" json:"hosts" yaml:"hosts"`
	// Experimental.
	Tls *k8s.IngressTls `field:"optional" json:"tls" yaml:"tls"`
}

Experimental.

type MetadataDatabase added in v0.0.3 

type MetadataDatabase interface {
	constructs.Construct
	// The tree node.
	// Experimental.
	Node() constructs.Node
	// Returns a string representation of this construct.
	// Experimental.
	ToString() *string
}

Experimental.

func NewMetadataDatabase added in v0.0.3 

func NewMetadataDatabase(scope constructs.Construct, id *string, props *MetadataDatabaseProps) MetadataDatabase

Experimental.

type MetadataDatabaseEnvOptions added in v0.0.5 

type MetadataDatabaseEnvOptions struct {
	// Experimental.
	Host *string `field:"optional" json:"host" yaml:"host"`
	// Experimental.
	Password *string `field:"optional" json:"password" yaml:"password"`
	// Experimental.
	Port *float64 `field:"optional" json:"port" yaml:"port"`
	// Experimental.
	User *string `field:"optional" json:"user" yaml:"user"`
}

Experimental.

type MetadataDatabaseOptions added in v0.0.3 

type MetadataDatabaseOptions struct {
	// Experimental.
	Architecture *string `field:"optional" json:"architecture" yaml:"architecture"`
	// Experimental.
	Auth *DatabaseAuthOptions `field:"optional" json:"auth" yaml:"auth"`
	// Experimental.
	Metrics *DatabaseMetricsOptions `field:"optional" json:"metrics" yaml:"metrics"`
	// Experimental.
	Replication *DatabaseReplicationOptions `field:"optional" json:"replication" yaml:"replication"`
	// Experimental.
	Resources *DatabaseResourcesOptions `field:"optional" json:"resources" yaml:"resources"`
	// Experimental.
	VolumePermissions *DatabaseVolumePermissionsOptions `field:"optional" json:"volumePermissions" yaml:"volumePermissions"`
}

Experimental.

type MetadataDatabaseProps added in v0.0.3 

type MetadataDatabaseProps struct {
	// Experimental.
	ChartVersion *string `field:"required" json:"chartVersion" yaml:"chartVersion"`
	// Experimental.
	ChartValues *MetadataDatabaseOptions `field:"optional" json:"chartValues" yaml:"chartValues"`
}

Experimental.

type MetaflowService 

type MetaflowService interface {
	constructs.Construct
	// The tree node.
	// Experimental.
	Node() constructs.Node
	// Returns a string representation of this construct.
	// Experimental.
	ToString() *string
}

Experimental.

func NewMetaflowService 

func NewMetaflowService(scope constructs.Construct, id *string, props *MetaflowServiceProps) MetaflowService

Experimental.

type MetaflowServiceOptions added in v0.0.3 

type MetaflowServiceOptions struct {
	// Experimental.
	Affinity *k8s.Affinity `field:"optional" json:"affinity" yaml:"affinity"`
	// Experimental.
	Autoscaling *AutoscalingOptions `field:"optional" json:"autoscaling" yaml:"autoscaling"`
	// Experimental.
	DbMigrations *DbMigrationOptions `field:"optional" json:"dbMigrations" yaml:"dbMigrations"`
	// Experimental.
	EnvFrom *[]*k8s.EnvFromSource `field:"optional" json:"envFrom" yaml:"envFrom"`
	// Experimental.
	FullnameOverride *string `field:"optional" json:"fullnameOverride" yaml:"fullnameOverride"`
	// Experimental.
	Image *ImageOptions `field:"optional" json:"image" yaml:"image"`
	// Experimental.
	ImagePullSecrets *[]*string `field:"optional" json:"imagePullSecrets" yaml:"imagePullSecrets"`
	// Experimental.
	Ingress *IngressOptions `field:"optional" json:"ingress" yaml:"ingress"`
	// Experimental.
	Metadatadb *MetadataDatabaseEnvOptions `field:"optional" json:"metadatadb" yaml:"metadatadb"`
	// Experimental.
	NameOverride *string `field:"optional" json:"nameOverride" yaml:"nameOverride"`
	// Experimental.
	NodeSelector *map[string]*string `field:"optional" json:"nodeSelector" yaml:"nodeSelector"`
	// Experimental.
	PodAnnotations *map[string]*string `field:"optional" json:"podAnnotations" yaml:"podAnnotations"`
	// Experimental.
	PodSecurityContext *map[string]*string `field:"optional" json:"podSecurityContext" yaml:"podSecurityContext"`
	// Experimental.
	ReplicaCount *float64 `field:"optional" json:"replicaCount" yaml:"replicaCount"`
	// Experimental.
	Resources *[]IApiResource `field:"optional" json:"resources" yaml:"resources"`
	// Experimental.
	SecurityContext *k8s.SecurityContext `field:"optional" json:"securityContext" yaml:"securityContext"`
	// Experimental.
	Service *ServiceOptions `field:"optional" json:"service" yaml:"service"`
	// Experimental.
	ServiceAccount *ServiceAccountOptions `field:"optional" json:"serviceAccount" yaml:"serviceAccount"`
	// Experimental.
	Tolerations *[]*k8s.Toleration `field:"optional" json:"tolerations" yaml:"tolerations"`
}

Experimental.

type MetaflowServiceProps 

type MetaflowServiceProps struct {
	// Experimental.
	ChartVersion *string `field:"required" json:"chartVersion" yaml:"chartVersion"`
	// Experimental.
	ChartValues *MetaflowServiceOptions `field:"optional" json:"chartValues" yaml:"chartValues"`
}

Experimental.

type MetaflowUI added in v0.0.3 

type MetaflowUI interface {
	constructs.Construct
	// The tree node.
	// Experimental.
	Node() constructs.Node
	// Returns a string representation of this construct.
	// Experimental.
	ToString() *string
}

Experimental.

func NewMetaflowUI added in v0.0.3 

func NewMetaflowUI(scope constructs.Construct, id *string, props *MetaflowUIProps) MetaflowUI

Experimental.

type MetaflowUIOptions added in v0.0.3 

type MetaflowUIOptions struct {
	// Experimental.
	Env *map[string]*string `field:"required" json:"env" yaml:"env"`
	// Experimental.
	Affinity *k8s.Affinity `field:"optional" json:"affinity" yaml:"affinity"`
	// Experimental.
	Autoscaling *AutoscalingOptions `field:"optional" json:"autoscaling" yaml:"autoscaling"`
	// Experimental.
	EnvFrom *[]*k8s.EnvFromSource `field:"optional" json:"envFrom" yaml:"envFrom"`
	// Experimental.
	FullnameOverride *string `field:"optional" json:"fullnameOverride" yaml:"fullnameOverride"`
	// Experimental.
	Image *ImageOptions `field:"optional" json:"image" yaml:"image"`
	// Experimental.
	ImagePullSecrets *[]*string `field:"optional" json:"imagePullSecrets" yaml:"imagePullSecrets"`
	// Experimental.
	Ingress *IngressOptions `field:"optional" json:"ingress" yaml:"ingress"`
	// Experimental.
	Metadatadb *MetadataDatabaseEnvOptions `field:"optional" json:"metadatadb" yaml:"metadatadb"`
	// Experimental.
	MetaflowDatastoreSysrootS3 *string `field:"optional" json:"metaflowDatastoreSysrootS3" yaml:"metaflowDatastoreSysrootS3"`
	// Experimental.
	NameOverride *string `field:"optional" json:"nameOverride" yaml:"nameOverride"`
	// Experimental.
	NodeSelector *map[string]*string `field:"optional" json:"nodeSelector" yaml:"nodeSelector"`
	// Experimental.
	PodAnnotations *map[string]*string `field:"optional" json:"podAnnotations" yaml:"podAnnotations"`
	// Experimental.
	PodSecurityContext *map[string]*string `field:"optional" json:"podSecurityContext" yaml:"podSecurityContext"`
	// Experimental.
	ReplicaCount *float64 `field:"optional" json:"replicaCount" yaml:"replicaCount"`
	// Experimental.
	Resources *[]IApiResource `field:"optional" json:"resources" yaml:"resources"`
	// Experimental.
	SecurityContext *k8s.SecurityContext `field:"optional" json:"securityContext" yaml:"securityContext"`
	// Experimental.
	Service *ServiceOptions `field:"optional" json:"service" yaml:"service"`
	// Experimental.
	ServiceAccount *ServiceAccountOptions `field:"optional" json:"serviceAccount" yaml:"serviceAccount"`
	// Experimental.
	ServiceStatic *ServiceOptions `field:"optional" json:"serviceStatic" yaml:"serviceStatic"`
	// Experimental.
	Tolerations *[]*k8s.Toleration `field:"optional" json:"tolerations" yaml:"tolerations"`
	// Experimental.
	UiImage *ImageOptions `field:"optional" json:"uiImage" yaml:"uiImage"`
}

Experimental.

type MetaflowUIProps added in v0.0.3 

type MetaflowUIProps struct {
	// Experimental.
	ChartVersion *string `field:"required" json:"chartVersion" yaml:"chartVersion"`
	// Experimental.
	ChartValues *MetaflowUIOptions `field:"optional" json:"chartValues" yaml:"chartValues"`
}

Experimental.

type ServiceAccountOptions added in v0.0.3 

type ServiceAccountOptions struct {
	// Experimental.
	Annotations *map[string]*string `field:"optional" json:"annotations" yaml:"annotations"`
	// Experimental.
	Create *bool `field:"optional" json:"create" yaml:"create"`
	// Experimental.
	Name *string `field:"optional" json:"name" yaml:"name"`
}

Experimental.

type ServiceOptions added in v0.0.3 

type ServiceOptions struct {
	// Experimental.
	Annotations *map[string]*string `field:"optional" json:"annotations" yaml:"annotations"`
	// Experimental.
	Port *float64 `field:"optional" json:"port" yaml:"port"`
	// Experimental.
	Type ServiceType `field:"optional" json:"type" yaml:"type"`
}

Experimental.

type ServiceType added in v0.0.3 

type ServiceType string

Experimental. 

const (
	// Experimental.
	ServiceType_CLUSTER_IP ServiceType = "CLUSTER_IP"
	// Experimental.
	ServiceType_NODE_PORT ServiceType = "NODE_PORT"
	// Experimental.
	ServiceType_LOAD_BALANCER ServiceType = "LOAD_BALANCER"
	// Experimental.
	ServiceType_EXTERNAL_NAME ServiceType = "EXTERNAL_NAME"
)

Source Files

View all Source files

Directories

Path Synopsis
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
 Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
k8s
internal
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.