Documentation
¶
Index ¶
- func GenerateCLIArangoDBOperatorIntegrationReadme(root string) error
- func GenerateCLIArangoDBOperatorOpsReadme(root string) error
- func GenerateCLIArangoDBOperatorPlatformReadme(root string) error
- func GenerateCLIArangoDBOperatorReadme(root string) error
- func GenerateHelp(cmd *cobra.Command, args ...string) (string, error)
- func GenerateHelpQuoted(cmd *cobra.Command, args ...string) (string, error)
- func GenerateHelpRaw(cmd *cobra.Command, args ...string) (string, error)
- func GenerateMetricsDocumentation(root string, in MetricsDoc) error
- func GenerateReadme(root string) error
- func GenerateReadmeFeatures(root, basePath string, eeOnly bool) (string, error)
- func GenerateReadmeLimits(root string) (string, error)
- func GenerateReadmePlatforms(root string) (string, error)
- func ListTimezones() ([]Timezone, []TimezoneData)
- func RenderActions(root string) error
- func RenderTimezones(root string) error
- type Action
- type ActionsInput
- func (i ActionsInput) Configurable() []string
- func (i ActionsInput) Deprecated() map[string]string
- func (i ActionsInput) Descriptions() map[string]string
- func (i ActionsInput) HighestScopes() map[string]string
- func (i ActionsInput) Internal() map[string]string
- func (i ActionsInput) Keys() []string
- func (i ActionsInput) Optionals() map[string]bool
- func (i ActionsInput) Scopes() map[string]Scopes
- func (i ActionsInput) StartFailureGracePeriods() map[string]string
- func (i ActionsInput) Timeouts() map[string]string
- type Alerting
- type Feature
- type FeatureRelease
- type FeatureReleases
- type Features
- type FeaturesDoc
- type Groups
- type Label
- type Limit
- type Limits
- type LimitsDoc
- type Metric
- type Metrics
- type MetricsDoc
- type Namespaces
- type Platform
- type PlatformVersion
- type Platforms
- type PlatformsDoc
- type Scopes
- type Timezone
- type TimezoneData
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateHelpQuoted ¶
func GenerateMetricsDocumentation ¶
func GenerateMetricsDocumentation(root string, in MetricsDoc) error
func GenerateReadme ¶
func GenerateReadmeFeatures ¶
func GenerateReadmeLimits ¶
func GenerateReadmePlatforms ¶
func ListTimezones ¶
func ListTimezones() ([]Timezone, []TimezoneData)
func RenderActions ¶
func RenderTimezones ¶
Types ¶
type Action ¶
type Action struct {
Timeout *meta.Duration `json:"timeout,omitempty"`
StartupFailureGracePeriod *meta.Duration `json:"startupFailureGracePeriod,omitempty"`
Scopes []string `json:"scopes,omitempty"`
Description string `json:"description"`
Enterprise bool `json:"enterprise"`
IsInternal bool `json:"isInternal"`
Optional bool `json:"optional"`
Configurable bool `json:"configurable"`
Deprecated *string `json:"deprecated"`
}
type ActionsInput ¶
type ActionsInput struct {
DefaultTimeout meta.Duration `json:"default_timeout"`
Actions map[string]Action `json:"actions"`
}
func (ActionsInput) Configurable ¶
func (i ActionsInput) Configurable() []string
func (ActionsInput) Deprecated ¶
func (i ActionsInput) Deprecated() map[string]string
func (ActionsInput) Descriptions ¶
func (i ActionsInput) Descriptions() map[string]string
func (ActionsInput) HighestScopes ¶
func (i ActionsInput) HighestScopes() map[string]string
func (ActionsInput) Internal ¶
func (i ActionsInput) Internal() map[string]string
func (ActionsInput) Keys ¶
func (i ActionsInput) Keys() []string
func (ActionsInput) Optionals ¶
func (i ActionsInput) Optionals() map[string]bool
func (ActionsInput) Scopes ¶
func (i ActionsInput) Scopes() map[string]Scopes
func (ActionsInput) StartFailureGracePeriods ¶
func (i ActionsInput) StartFailureGracePeriods() map[string]string
func (ActionsInput) Timeouts ¶
func (i ActionsInput) Timeouts() map[string]string
type Feature ¶
type Feature struct {
Name string `json:"name,omitempty" yaml:"name,omitempty"`
Releases FeatureReleases `json:"releases,omitempty" yaml:"releases,omitempty"`
FeatureRelease `json:",inline" yaml:",inline"`
}
type FeatureRelease ¶
type FeatureRelease struct {
Doc *string `json:"doc,omitempty" yaml:"doc,omitempty"`
OperatorVersion *string `json:"operatorVersion,omitempty" yaml:"operatorVersion,omitempty"`
ArangoDBVersion *string `json:"arangoDBVersion,omitempty" yaml:"arangoDBVersion,omitempty"`
OperatorEdition *string `json:"operatorEditions,omitempty" yaml:"operatorEditions,omitempty"`
ArangoDBEdition *string `json:"arangoDBEditions,omitempty" yaml:"arangoDBEditions,omitempty"`
State *string `json:"state,omitempty" yaml:"state,omitempty"`
Flag *string `json:"flag,omitempty" yaml:"flag,omitempty"`
Remarks *string `json:"remarks,omitempty" yaml:"remarks,omitempty"`
Enabled *bool `json:"enabled,omitempty" yaml:"enabled,omitempty"`
}
type FeatureReleases ¶
type FeatureReleases []FeatureRelease
type FeaturesDoc ¶
type FeaturesDoc struct {
Features Features `json:"features,omitempty" yaml:"features,omitempty"`
}
type LimitsDoc ¶
type LimitsDoc struct {
Limits Limits `json:"limits,omitempty" yaml:"limits,omitempty"`
}
type Metric ¶
type Metric struct {
Description string `json:"description" yaml:"description"`
Type string `json:"type" yaml:"type"`
ShortDescription string `json:"shortDescription" yaml:"shortDescription"`
Global bool `json:"global" yaml:"global"`
Labels []Label `json:"labels" yaml:"labels"`
AlertingRules []Alerting `json:"alertingRules" yaml:"alertingRules"`
}
type MetricsDoc ¶
type MetricsDoc struct {
Destination string `json:"destination" yaml:"destination"`
Documentation string `json:"documentation" yaml:"documentation"`
Namespaces Namespaces `json:"namespaces" yaml:"namespaces"`
}
type Namespaces ¶
func (Namespaces) Keys ¶
func (n Namespaces) Keys() []string
type Platform ¶
type Platform struct {
Name string `json:"name,omitempty" yaml:"name,omitempty"`
Versions []PlatformVersion `json:"versions,omitempty" yaml:"versions,omitempty"`
}
type PlatformVersion ¶
type PlatformVersion struct {
KubernetesVersion *string `json:"kubernetesVersion,omitempty" yaml:"kubernetesVersion,omitempty"`
ArangoDBVersion *string `json:"arangoDBVersion,omitempty" yaml:"arangoDBVersion,omitempty"`
State *string `json:"state,omitempty" yaml:"state,omitempty"`
Remarks *string `json:"remarks,omitempty" yaml:"remarks,omitempty"`
ProviderRemarks *string `json:"providerRemarks,omitempty" yaml:"providerRemarks,omitempty"`
}
type PlatformsDoc ¶
type PlatformsDoc struct {
Platforms Platforms `json:"platforms,omitempty" yaml:"platforms,omitempty"`
}
type TimezoneData ¶
Click to show internal directories.
Click to hide internal directories.