configurators

Documentation

Index

• type BootstrapFlags
• type Configurator
• type ConfiguratorAction
• type ConfiguratorActionContext
• type TargetService
  • func (t TargetService) IsDiscovery() bool
  • func (t TargetService) Name() string
  • func (t TargetService) UseDiscoveryServiceConfig() bool

Types

type BootstrapFlags

type BootstrapFlags struct {
	// Service specifies the target service for bootstrapping.
	Service TargetService
	// ConfigPath database agent configuration path.
	ConfigPath string
	// Manual boolean indicating if the configurator will perform the
	// instructions or if it will be the user.
	Manual bool
	// PolicyName name of the generated policy.
	PolicyName string
	// AttachToUser user that the generated policies will be attached to.
	AttachToUser string
	// AttachToRole role that the generated policies will be attached to.
	AttachToRole string
	// ForceRDSPermissions forces the presence of RDS permissions.
	ForceRDSPermissions bool
	// ForceRDSProxyPermissions forces the presence of RDS Proxy permissions.
	ForceRDSProxyPermissions bool
	// ForceRedshiftPermissions forces the presence of Redshift permissions.
	ForceRedshiftPermissions bool
	// ForceRedshiftServerlessPermissions forces the presence of Redshift Serverless permissions.
	ForceRedshiftServerlessPermissions bool
	// ForceElastiCachePermissions forces the presence of ElastiCache permissions.
	ForceElastiCachePermissions bool
	// ForceMemoryDBPermissions forces the presence of MemoryDB permissions.
	ForceMemoryDBPermissions bool
	// ForceEC2Permissions forces the presence of EC2 permissions.
	ForceEC2Permissions bool
	// ForceAWSKeyspacesPermissions forces the presence of AWS Keyspaces permissions.
	ForceAWSKeyspacesPermissions bool
	// ForceDynamoDBPermissions forces the presence of DynamoDB permissions.
	ForceDynamoDBPermissions bool
	// ForceOpenSearchPermissions forces the presence of OpenSearch permissions.
	ForceOpenSearchPermissions bool
	// Proxy is the address of the Teleport proxy to use.
	Proxy string
	// ForceAssumesRoles forces the presence of additional external AWS IAM roles to assume.
	ForceAssumesRoles string
}

BootstrapFlags flags provided by users to configure and define how the configurators will work.

type Configurator

type Configurator interface {
	// Actions return the list of actions that needs to be performed by the
	// users (when in manual mode) or by the configurator itself.
	Actions() []ConfiguratorAction
	// Name returns the configurator name.
	Name() string
	// Description returns a brief description of the configurator.
	Description() string
	// IsEmpty defines if the configurator will have to perform any action.
	IsEmpty() bool
}

Configurator responsible for generating a list of actions that needs to be performed in the database agent bootstrap process.

type ConfiguratorAction

type ConfiguratorAction interface {
	// Description returns human-readable description of what the action will
	// do.
	Description() string
	// Details if the action has some additional information, such as a JSON
	// payload, it will be returned in the `Details`.
	Details() string
	// Execute executes the action with the provided context. It might or not
	// modify the `ConfiguratorActionContext`.
	//
	// Actions can store and retrieve information from the
	// `ConfiguratorActionContext` that is passed to `Execute`. For example,
	// if an action requires information that was generated by a previous action.
	// It should retrieve this information from context.
	Execute(context.Context, *ConfiguratorActionContext) error
}

ConfiguratorAction is single configurator action, its details can be retrieved using `Description` and `Details`, and executed using `Execute` function.

type ConfiguratorActionContext

type ConfiguratorActionContext struct {
	// AWSPolicyArn AWS ARN of the created policy.
	AWSPolicyArn string
	// AWS ARN of the created policy boundary.
	AWSPolicyBoundaryArn string
}

ConfiguratorActionContext context passed across configurator actions. It is used to share attributes between actions.

type TargetService

type TargetService int

TargetService is the target service for bootstrapping.

const (
	// DatabaseService indicates the bootstrap is for database service. Cloud
	// matchers and static databases are scanned from `database_service` and
	// both discovery and access/auth permissions will be collected.
	DatabaseService TargetService = iota
	// DiscoveryService indicates the bootstrap is for discovery service. Cloud
	// matchers are scanned from `discovery_service` and discovery permissions
	// will be collected.
	DiscoveryService
	// DatabaseServiceByDiscoveryServiceConfig indicates the bootstrap is for
	// database service that is receiving dynamic/discovered resources from the
	// discovery service. Cloud matchers are scanned from `discovery_service`
	// and access/auth permissions will be collected.
	DatabaseServiceByDiscoveryServiceConfig
)

func (TargetService) IsDiscovery

func (t TargetService) IsDiscovery() bool

IsDiscovery returns true if target is discovery service.

func (TargetService) Name

func (t TargetService) Name() string

Name returns the target service name.

func (TargetService) UseDiscoveryServiceConfig

func (t TargetService) UseDiscoveryServiceConfig() bool

UseDiscoveryServiceConfig returns true if target is using discovery service config.