config

Documentation

Index

• type Config
  • func (c *Config) CertPath() string
  • func (c *Config) CreateKubeconfig() error
  • func (c *Config) GenerateFiles() error
  • func (c *Config) GetOrCreateCertificate() (*tls.Certificate, error)
  • func (c *Config) KeyPath() string
  • func (c *Config) ListenAddr() string
  • func (c *Config) ListenURL() string
  • func (c *Config) LoadExistingCertificate() (*tls.Certificate, error)
• type RoleMapping
• type UserMapping

Types

type Config

type Config struct {
	// ClusterID is a unique-per-cluster identifier for your
	// heptio-authenticator-aws installation.
	ClusterID string

	// KubeconfigPregenerated is set to `true` when a webhook kubeconfig is
	// pre-generated by running the `init` command, and therefore the
	// `server` shouldn't unnecessarily re-generate a new one.
	KubeconfigPregenerated bool

	// LocalhostPort is the TCP on which to listen for authentication checks
	// (on localhost).
	LocalhostPort int

	// GenerateKubeconfigPath is the output path where a generated webhook
	// kubeconfig (for `--authentication-token-webhook-config-file`) will be
	// stored.
	GenerateKubeconfigPath string

	// StateDir is the directory where generated certificates and private keys
	// will be stored. You want these persisted between runs so that your API
	// server webhook configuration doesn't change on restart.
	StateDir string

	// RoleMappings is a list of mappings from AWS IAM Role to
	// Kubernetes username + groups.
	RoleMappings []RoleMapping

	// UserMappings is a list of mappings from AWS IAM User to
	// Kubernetes username + groups.
	UserMappings []UserMapping

	// AutoMappedAWSAccounts is a list of AWS accounts that are allowed without an explicit user/role mapping.
	// IAM ARN from these accounts automatically maps to the Kubernetes username.
	AutoMappedAWSAccounts []string

	// ServerEC2DescribeInstancesRoleARN is an optional AWS Resource Name for an IAM Role to be assumed
	// before calling ec2:DescribeInstances to determine the private DNS of the calling kubelet (EC2 Instance).
	// If nil, defaults to using the IAM Role attached to the instance where heptio-authenticator-aws is
	// running.
	ServerEC2DescribeInstancesRoleARN string
}

Config specifies the configuration for a heptio-authenticator-aws server

func (*Config) CertPath

func (c *Config) CertPath() string

CertPath returns the path to the pem file containing the certificate

func (*Config) CreateKubeconfig

func (c *Config) CreateKubeconfig() error

func (*Config) GenerateFiles

func (c *Config) GenerateFiles() error

func (*Config) GetOrCreateCertificate

func (c *Config) GetOrCreateCertificate() (*tls.Certificate, error)

func (*Config) KeyPath

func (c *Config) KeyPath() string

KeyPath returns the path to the pem file containing the private key

func (*Config) ListenAddr

func (c *Config) ListenAddr() string

func (*Config) ListenURL

func (c *Config) ListenURL() string

func (*Config) LoadExistingCertificate

func (c *Config) LoadExistingCertificate() (*tls.Certificate, error)

type RoleMapping

type RoleMapping struct {
	// RoleARN is the AWS Resource Name of the role. (e.g., "arn:aws:iam::000000000000:role/Foo").
	RoleARN string

	// Username is the username pattern that this instances assuming this
	// role will have in Kubernetes.
	Username string

	// Groups is a list of Kubernetes groups this role will authenticate
	// as (e.g., `system:masters`). Each group name can include placeholders.
	Groups []string
}

RoleMapping is a mapping of an AWS Role ARN to a Kubernetes username and a list of Kubernetes groups. The username and groups are specified as templates that may optionally contain two template parameters:

1. "{{AccountID}}" is the 12 digit AWS ID.
2. "{{SessionName}}" is the role session name.

The meaning of SessionName depends on the type of entity assuming the role. In the case of an EC2 instance role this will be the EC2 instance ID. In the case of a federated role it will be the federated identity (controlled by the federated identity provider). In the case of a role assumed directly with sts:AssumeRole it will be user controlled.

You can use plain values without parameters to have a more static mapping.

type UserMapping

type UserMapping struct {
	// UserARN is the AWS Resource Name of the user. (e.g., "arn:aws:iam::000000000000:user/Test").
	UserARN string

	// Username is the Kubernetes username this role will authenticate as (e.g., `mycorp:foo`)
	Username string

	// Groups is a list of Kubernetes groups this role will authenticate as (e.g., `system:masters`)
	Groups []string
}

UserMapping is a static mapping of a single AWS User ARN to a Kubernetes username and a list of Kubernetes groups