Documentation
¶
Index ¶
- type IPAccessList
- func (i IPAccessList) WithAWSGroup(group string) IPAccessList
- func (i IPAccessList) WithCIDR(cidr string) IPAccessList
- func (i IPAccessList) WithComment(comment string) IPAccessList
- func (i IPAccessList) WithDeleteAfterDate(date string) IPAccessList
- func (i IPAccessList) WithIP(ip string) IPAccessList
- type Integration
- type MaintenanceWindow
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type IPAccessList ¶
type IPAccessList struct {
// Unique identifier of AWS security group in this access list entry.
// +optional
AwsSecurityGroup string `json:"awsSecurityGroup,omitempty"`
// Range of IP addresses in CIDR notation in this access list entry.
// +optional
CIDRBlock string `json:"cidrBlock,omitempty"`
// Comment associated with this access list entry.
// +optional
Comment string `json:"comment,omitempty"`
// Timestamp in ISO 8601 date and time format in UTC after which Atlas deletes the temporary access list entry.
// +optional
DeleteAfterDate string `json:"deleteAfterDate,omitempty"`
// Entry using an IP address in this access list entry.
// +optional
IPAddress string `json:"ipAddress,omitempty"`
}
IPAccessList allows the use of the IP Access List for a Project. See more information at https://docs.atlas.mongodb.com/reference/api/ip-access-list/add-entries-to-access-list/ Deprecated: Migrate to the AtlasIPAccessList Custom Resource in accordance with the migration guide at https://www.mongodb.com/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
func NewIPAccessList ¶
func NewIPAccessList() IPAccessList
func (IPAccessList) WithAWSGroup ¶
func (i IPAccessList) WithAWSGroup(group string) IPAccessList
func (IPAccessList) WithCIDR ¶
func (i IPAccessList) WithCIDR(cidr string) IPAccessList
func (IPAccessList) WithComment ¶
func (i IPAccessList) WithComment(comment string) IPAccessList
func (IPAccessList) WithDeleteAfterDate ¶
func (i IPAccessList) WithDeleteAfterDate(date string) IPAccessList
func (IPAccessList) WithIP ¶
func (i IPAccessList) WithIP(ip string) IPAccessList
type Integration ¶
type Integration struct {
// Third Party Integration type such as Slack, New Relic, etc.
// Each integration type requires a distinct set of configuration fields.
// For example, if you set type to DATADOG, you must configure only datadog subfields.
// +kubebuilder:validation:Enum=PAGER_DUTY;SLACK;DATADOG;NEW_RELIC;OPS_GENIE;VICTOR_OPS;FLOWDOCK;WEBHOOK;MICROSOFT_TEAMS;PROMETHEUS
// +optional
Type string `json:"type,omitempty"`
// Reference to a Kubernetes Secret containing your Unique 40-hexadecimal digit string that identifies your New Relic license.
// +optional
LicenseKeyRef common.ResourceRefNamespaced `json:"licenseKeyRef,omitempty"`
// Unique 40-hexadecimal digit string that identifies your New Relic account.
// +optional
AccountID string `json:"accountId,omitempty"`
// Reference to a Kubernetes Secret containing the insert key associated with your New Relic account.
// +optional
WriteTokenRef common.ResourceRefNamespaced `json:"writeTokenRef,omitempty"`
// Reference to a Kubernetes Secret containing the query key associated with your New Relic account.
// +optional
ReadTokenRef common.ResourceRefNamespaced `json:"readTokenRef,omitempty"`
// Reference to a Kubernetes Secret containing your API Key for Datadog, OpsGenie or Victor Ops.
// +optional
APIKeyRef common.ResourceRefNamespaced `json:"apiKeyRef,omitempty"`
// Region code indicating which regional API Atlas uses to access PagerDuty, Datadog, or OpsGenie.
// +optional
Region string `json:"region,omitempty"`
// Reference to a Kubernetes Secret containing the service key associated with your PagerDuty account.
// +optional
ServiceKeyRef common.ResourceRefNamespaced `json:"serviceKeyRef,omitempty"`
// Reference to a Kubernetes Secret containing the Key that allows Atlas to access your Slack account.
// +optional
APITokenRef common.ResourceRefNamespaced `json:"apiTokenRef,omitempty"`
// Human-readable label that identifies your Slack team.
// +optional
TeamName string `json:"teamName,omitempty"`
// Name of the Slack channel to which Atlas sends alert notifications.
// +optional
ChannelName string `json:"channelName,omitempty"`
// Reference to a Kubernetes Secret containing the Routing key associated with your Splunk On-Call account.
// Used for Victor Ops.
// +optional
RoutingKeyRef common.ResourceRefNamespaced `json:"routingKeyRef,omitempty"`
// +optional
FlowName string `json:"flowName,omitempty"`
// +optional
OrgName string `json:"orgName,omitempty"`
// Endpoint web address to which Atlas sends notifications.
// Used for Webhooks.
// +optional
URL string `json:"url,omitempty"`
// Reference to a Kubernetes Secret containing the secret for your Webhook.
// +optional
SecretRef common.ResourceRefNamespaced `json:"secretRef,omitempty"`
// +optional
Name string `json:"name,omitempty"`
// Endpoint web address of the Microsoft Teams webhook to which Atlas sends notifications.
// +optional
MicrosoftTeamsWebhookURL string `json:"microsoftTeamsWebhookUrl,omitempty"`
// Human-readable label that identifies your Prometheus incoming webhook.
// +optional
UserName string `json:"username,omitempty"`
// Reference to a Kubernetes Secret containing the password to allow Atlas to access your Prometheus account.
// +optional
PasswordRef common.ResourceRefNamespaced `json:"passwordRef,omitempty"`
// Desired method to discover the Prometheus service.
// +optional
ServiceDiscovery string `json:"serviceDiscovery,omitempty"`
// +optional
Scheme string `json:"scheme,omitempty"`
//
// +optional
Enabled bool `json:"enabled,omitempty"`
}
Integration for the project between Atlas and a third party service. Deprecated: Migrate to the AtlasThirdPartyIntegration custom resource in accordance with the migration guide at https://www.mongodb.com/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
func (Integration) Identifier ¶
func (i Integration) Identifier() interface{}
type MaintenanceWindow ¶
type MaintenanceWindow struct {
// Day of the week when you would like the maintenance window to start as a 1-based integer.
// Sunday 1, Monday 2, Tuesday 3, Wednesday 4, Thursday 5, Friday 6, Saturday 7.
// +optional
// +kubebuilder:validation:Minimum=1
// +kubebuilder:validation:Maximum=7
DayOfWeek int `json:"dayOfWeek,omitempty"`
// Hour of the day when you would like the maintenance window to start.
// This parameter uses the 24-hour clock, where midnight is 0, noon is 12.
// +optional
// +kubebuilder:validation:Minimum=0
// +kubebuilder:validation:Maximum=23
HourOfDay int `json:"hourOfDay,omitempty"`
// Flag indicating whether any scheduled project maintenance should be deferred automatically for one week.
// +optional
AutoDefer bool `json:"autoDefer,omitempty"`
// Flag indicating whether project maintenance has been directed to start immediately.
// Cannot be specified if defer is true
// +optional
StartASAP bool `json:"startASAP,omitempty"`
// Flag indicating whether the next scheduled project maintenance should be deferred for one week.
// Cannot be specified if startASAP is true
// +optional
Defer bool `json:"defer,omitempty"`
}