Documentation
¶
Overview ¶
cdk8s-metaflow
cdk8s-metaflow
cdk8s-metaflow
cdk8s-metaflow
cdk8s-metaflow
cdk8s-metaflow
cdk8s-metaflow
cdk8s-metaflow
cdk8s-metaflow
cdk8s-metaflow
cdk8s-metaflow
cdk8s-metaflow
cdk8s-metaflow
cdk8s-metaflow
Index ¶
- func HelmPostgresAddon_NAME() *string
- func LocalPostgresAddon_NAME() *string
- func MetaflowService_IsChart(x interface{}) *bool
- func MetaflowService_IsConstruct(x interface{}) *bool
- func MetaflowService_Of(c constructs.IConstruct) cdk8s.Chart
- func NewHelmPostgresAddon_Override(h HelmPostgresAddon, props *HelmPostgresAddonProps)
- func NewLocalPostgresAddon_Override(l LocalPostgresAddon, props *LocalPostgresAddonProps)
- func NewMetaflowService_Override(m MetaflowService, scope constructs.Construct, name *string, ...)
- type DatabaseAuthOptions
- type DatabaseMetricsOptions
- type DatabaseReplicationOptions
- type DatabaseResourceRequestOptions
- type DatabaseResourcesOptions
- type DatabaseVolumePermissionsOptions
- type HelmPostgresAddon
- type HelmPostgresAddonProps
- type IAddon
- type LocalPostgresAddon
- type LocalPostgresAddonProps
- type MetadataDatabaseOptions
- type MetaflowChartProps
- type MetaflowService
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func HelmPostgresAddon_NAME ¶ added in v0.0.10
func HelmPostgresAddon_NAME() *string
func LocalPostgresAddon_NAME ¶ added in v0.0.10
func LocalPostgresAddon_NAME() *string
func MetaflowService_IsChart ¶ added in v0.0.10
func MetaflowService_IsChart(x interface{}) *bool
Return whether the given object is a Chart.
We do attribute detection since we can't reliably use 'instanceof'. 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 MetaflowService_Of ¶ added in v0.0.10
func MetaflowService_Of(c constructs.IConstruct) cdk8s.Chart
Finds the chart in which a node is defined. Experimental.
func NewHelmPostgresAddon_Override ¶ added in v0.0.10
func NewHelmPostgresAddon_Override(h HelmPostgresAddon, props *HelmPostgresAddonProps)
Experimental.
func NewLocalPostgresAddon_Override ¶ added in v0.0.10
func NewLocalPostgresAddon_Override(l LocalPostgresAddon, props *LocalPostgresAddonProps)
Experimental.
func NewMetaflowService_Override ¶
func NewMetaflowService_Override(m MetaflowService, scope constructs.Construct, name *string, props *MetaflowChartProps)
Experimental.
Types ¶
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 HelmPostgresAddon ¶ added in v0.0.10
type HelmPostgresAddon interface { IAddon // Experimental. Name() *string // Experimental. Install(scope constructs.Construct) constructs.Construct }
Experimental.
func NewHelmPostgresAddon ¶ added in v0.0.10
func NewHelmPostgresAddon(props *HelmPostgresAddonProps) HelmPostgresAddon
Experimental.
type HelmPostgresAddonProps ¶ added in v0.0.10
type HelmPostgresAddonProps struct { // Experimental. ChartVersion *string `field:"required" json:"chartVersion" yaml:"chartVersion"` // Experimental. NamespaceName *string `field:"required" json:"namespaceName" yaml:"namespaceName"` // Experimental. ChartValues *MetadataDatabaseOptions `field:"optional" json:"chartValues" yaml:"chartValues"` }
Experimental.
type IAddon ¶ added in v0.0.9
type IAddon interface { // Experimental. Install(scope constructs.Construct) constructs.Construct // Experimental. Name() *string }
Experimental.
type LocalPostgresAddon ¶ added in v0.0.10
type LocalPostgresAddon interface { IAddon // Experimental. Name() *string // Experimental. Install(scope constructs.Construct) constructs.Construct }
Experimental.
func NewLocalPostgresAddon ¶ added in v0.0.10
func NewLocalPostgresAddon(props *LocalPostgresAddonProps) LocalPostgresAddon
Experimental.
type LocalPostgresAddonProps ¶ added in v0.0.10
type LocalPostgresAddonProps struct { // Experimental. EndpointIp *string `field:"required" json:"endpointIp" yaml:"endpointIp"` // Experimental. NamespaceName *string `field:"optional" json:"namespaceName" yaml:"namespaceName"` }
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 MetaflowChartProps ¶ added in v0.0.9
type MetaflowChartProps struct { // Labels to apply to all resources in this chart. // Experimental. Labels *map[string]*string `field:"optional" json:"labels" yaml:"labels"` // The default namespace for all objects defined in this chart (directly or indirectly). // // This namespace will only apply to objects that don't have a // `namespace` explicitly defined for them. // Experimental. Namespace *string `field:"optional" json:"namespace" yaml:"namespace"` // Experimental. Image *string `field:"required" json:"image" yaml:"image"` // Experimental. ImageTag *string `field:"required" json:"imageTag" yaml:"imageTag"` // Experimental. ServicePort *cdk8splus21.ServicePort `field:"required" json:"servicePort" yaml:"servicePort"` // Experimental. EnvVars *map[string]*string `field:"optional" json:"envVars" yaml:"envVars"` // Experimental. InitImage *string `field:"optional" json:"initImage" yaml:"initImage"` // Experimental. InitImageTag *string `field:"optional" json:"initImageTag" yaml:"initImageTag"` // Experimental. ServiceAccount cdk8splus21.IServiceAccount `field:"optional" json:"serviceAccount" yaml:"serviceAccount"` }
Experimental.
type MetaflowService ¶
type MetaflowService interface { cdk8s.Chart // Labels applied to all resources in this chart. // // This is an immutable copy. // Experimental. Labels() *map[string]*string // The default namespace for all objects in this chart. // Experimental. Namespace() *string // The tree node. // Experimental. Node() constructs.Node // Experimental. ServiceAccount() cdk8splus21.IServiceAccount // Create a dependency between this Chart and other constructs. // // These can be other ApiObjects, Charts, or custom. // Experimental. AddDependency(dependencies ...constructs.IConstruct) // Generates a app-unique name for an object given it's construct node path. // // Different resource types may have different constraints on names // (`metadata.name`). The previous version of the name generator was // compatible with DNS_SUBDOMAIN but not with DNS_LABEL. // // For example, `Deployment` names must comply with DNS_SUBDOMAIN while // `Service` names must comply with DNS_LABEL. // // Since there is no formal specification for this, the default name // generation scheme for kubernetes objects in cdk8s was changed to DNS_LABEL, // since it’s the common denominator for all kubernetes resources // (supposedly). // // You can override this method if you wish to customize object names at the // chart level. // Experimental. GenerateObjectName(apiObject cdk8s.ApiObject) *string // Renders this chart to a set of Kubernetes JSON resources. // // Returns: array of resource manifests. // Experimental. ToJson() *[]interface{} // Returns a string representation of this construct. // Experimental. ToString() *string }
Experimental.
func NewMetaflowService ¶
func NewMetaflowService(scope constructs.Construct, name *string, props *MetaflowChartProps) MetaflowService
Experimental.
Source Files
¶
- cdk8smetaflow.go
- cdk8smetaflow_DatabaseAuthOptions.go
- cdk8smetaflow_DatabaseMetricsOptions.go
- cdk8smetaflow_DatabaseReplicationOptions.go
- cdk8smetaflow_DatabaseResourceRequestOptions.go
- cdk8smetaflow_DatabaseResourcesOptions.go
- cdk8smetaflow_DatabaseVolumePermissionsOptions.go
- cdk8smetaflow_HelmPostgresAddon.go
- cdk8smetaflow_HelmPostgresAddonProps.go
- cdk8smetaflow_IAddon.go
- cdk8smetaflow_LocalPostgresAddon.go
- cdk8smetaflow_LocalPostgresAddonProps.go
- cdk8smetaflow_MetadataDatabaseOptions.go
- cdk8smetaflow_MetaflowChartProps.go
- cdk8smetaflow_MetaflowService.go