Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

AWS assume role #611

Merged
merged 4 commits into from
Jun 3, 2024
Merged

AWS assume role #611

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
462a81c
Add assume role support to BBL
danielfor May 5, 2023
1cb0062
Pass AWS assume role ops files and variables
ystros May 9, 2023
7e72493
Add error when using assume role + state bucket
ystros May 9, 2023
7b14773
Fix linter/test
teddyking Jun 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions aws/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (

awslib "github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/credentials"
"github.com/aws/aws-sdk-go/aws/credentials/stscreds"
"github.com/aws/aws-sdk-go/aws/session"
awsec2 "github.com/aws/aws-sdk-go/service/ec2"
awsroute53 "github.com/aws/aws-sdk-go/service/route53"
Expand Down Expand Up @@ -43,14 +44,19 @@ type Client struct {
}

func NewClient(creds storage.AWS, logger logger) Client {
config := &awslib.Config{
Credentials: credentials.NewStaticCredentials(creds.AccessKeyID, creds.SecretAccessKey, ""),
Region: awslib.String(creds.Region),
config := awslib.NewConfig().
WithCredentials(credentials.NewStaticCredentials(creds.AccessKeyID, creds.SecretAccessKey, "")).
WithRegion(creds.Region)
awsSession := session.Must(session.NewSession(config))

if creds.AssumeRoleArn != "" {
stsCredentials := stscreds.NewCredentials(awsSession, creds.AssumeRoleArn)
awsSession = session.Must(session.NewSession(awslib.NewConfig().WithCredentials(stsCredentials).WithRegion(creds.Region)))
}

return Client{
ec2Client: awsec2.New(session.Must(session.NewSession(config))),
route53Client: awsroute53.New(session.Must(session.NewSession(config))),
ec2Client: awsec2.New(awsSession),
route53Client: awsroute53.New(awsSession),
logger: logger,
}
}
Expand Down
31 changes: 29 additions & 2 deletions bosh/executor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,10 @@ func (e Executor) getSetupFiles(sourcePath, destPath string) []setupFile {
}

func (e Executor) PlanJumpbox(input DirInput, deploymentDir, iaas string) error {
return e.PlanJumpboxWithState(input, deploymentDir, iaas, storage.State{})
}

func (e Executor) PlanJumpboxWithState(input DirInput, deploymentDir, iaas string, state storage.State) error {
setupFiles := e.getSetupFiles(jumpboxDeploymentRepo, deploymentDir)

for _, f := range setupFiles {
Expand Down Expand Up @@ -128,6 +132,12 @@ func (e Executor) PlanJumpbox(input DirInput, deploymentDir, iaas string) error
}
}

if iaas == "aws" {
if state.AWS.AssumeRoleArn != "" {
sharedArgs = append(sharedArgs, "-o", filepath.Join(deploymentDir, "aws", "cpi-assume-role-credentials.yml"))
}
}

jumpboxState := filepath.Join(input.VarsDir, "jumpbox-state.json")

boshArgs := append([]string{filepath.Join(deploymentDir, "jumpbox.yml"), "--state", jumpboxState}, sharedArgs...)
Expand All @@ -138,6 +148,11 @@ func (e Executor) PlanJumpbox(input DirInput, deploymentDir, iaas string) error
"-v", `access_key_id="${BBL_AWS_ACCESS_KEY_ID}"`,
"-v", `secret_access_key="${BBL_AWS_SECRET_ACCESS_KEY}"`,
)
if state.AWS.AssumeRoleArn != "" {
boshArgs = append(boshArgs,
"-v", `role_arn="${BBL_AWS_ASSUME_ROLE}"`,
)
}
case "azure":
boshArgs = append(boshArgs,
"-v", `subscription_id="${BBL_AZURE_SUBSCRIPTION_ID}"`,
Expand Down Expand Up @@ -210,7 +225,7 @@ func (e Executor) getDirectorSetupFiles(stateDir, deploymentDir, iaas string) []
return files
}

func (e Executor) getDirectorOpsFiles(stateDir, deploymentDir, iaas string) []string {
func (e Executor) getDirectorOpsFiles(stateDir, deploymentDir, iaas string, state storage.State) []string {
files := []string{
filepath.Join(deploymentDir, iaas, "cpi.yml"),
filepath.Join(deploymentDir, "jumpbox-user.yml"),
Expand All @@ -223,13 +238,20 @@ func (e Executor) getDirectorOpsFiles(stateDir, deploymentDir, iaas string) []st
files = append(files, filepath.Join(stateDir, "bbl-ops-files", iaas, "bosh-director-ephemeral-ip-ops.yml"))
files = append(files, filepath.Join(deploymentDir, iaas, "iam-instance-profile.yml"))
files = append(files, filepath.Join(deploymentDir, iaas, "encrypted-disk.yml"))
if state.AWS.AssumeRoleArn != "" {
files = append(files, filepath.Join(deploymentDir, iaas, "cpi-assume-role-credentials.yml"))
}
} else if iaas == "vsphere" {
files = append(files, filepath.Join(deploymentDir, "vsphere", "resource-pool.yml"))
}
return files
}

func (e Executor) PlanDirector(input DirInput, deploymentDir, iaas string) error {
return e.PlanDirectorWithState(input, deploymentDir, iaas, storage.State{})
}

func (e Executor) PlanDirectorWithState(input DirInput, deploymentDir, iaas string, state storage.State) error {
setupFiles := e.getDirectorSetupFiles(input.StateDir, deploymentDir, iaas)

for _, f := range setupFiles {
Expand All @@ -246,7 +268,7 @@ func (e Executor) PlanDirector(input DirInput, deploymentDir, iaas string) error
"--vars-file", filepath.Join(input.VarsDir, "director-vars-file.yml"),
}

for _, f := range e.getDirectorOpsFiles(input.StateDir, deploymentDir, iaas) {
for _, f := range e.getDirectorOpsFiles(input.StateDir, deploymentDir, iaas, state) {
sharedArgs = append(sharedArgs, "-o", f)
}

Expand All @@ -260,6 +282,11 @@ func (e Executor) PlanDirector(input DirInput, deploymentDir, iaas string) error
"-v", `access_key_id="${BBL_AWS_ACCESS_KEY_ID}"`,
"-v", `secret_access_key="${BBL_AWS_SECRET_ACCESS_KEY}"`,
)
if state.AWS.AssumeRoleArn != "" {
boshArgs = append(boshArgs,
"-v", `role_arn="${BBL_AWS_ASSUME_ROLE}"`,
)
}
case "azure":
boshArgs = append(boshArgs,
"-v", `subscription_id="${BBL_AZURE_SUBSCRIPTION_ID}"`,
Expand Down
170 changes: 123 additions & 47 deletions bosh/executor_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,55 +75,102 @@ var _ = Describe("Executor", func() {
})

Describe("PlanJumpbox", func() {
It("writes bosh-deployment assets to the deployment dir", func() {
err := executor.PlanJumpbox(dirInput, deploymentDir, "aws")
Expect(err).NotTo(HaveOccurred())
Context("on aws", func() {
It("writes bosh-deployment assets to the deployment dir", func() {
err := executor.PlanJumpbox(dirInput, deploymentDir, "aws")
Expect(err).NotTo(HaveOccurred())

By("writing bosh-deployment assets to the deployment dir", func() {
simplePath := filepath.Join(deploymentDir, "no-external-ip.yml")
By("writing bosh-deployment assets to the deployment dir", func() {
simplePath := filepath.Join(deploymentDir, "no-external-ip.yml")

contents, err := fs.ReadFile(simplePath)
Expect(err).NotTo(HaveOccurred())
Expect(string(contents)).To(Equal("no-ip"))
contents, err := fs.ReadFile(simplePath)
Expect(err).NotTo(HaveOccurred())
Expect(string(contents)).To(Equal("no-ip"))

nestedPath := filepath.Join(deploymentDir, "aws", "cpi.yml")
nestedPath := filepath.Join(deploymentDir, "aws", "cpi.yml")

contents, err = fs.ReadFile(nestedPath)
Expect(err).NotTo(HaveOccurred())
Expect(string(contents)).To(Equal("aws-cpi"))
contents, err = fs.ReadFile(nestedPath)
Expect(err).NotTo(HaveOccurred())
Expect(string(contents)).To(Equal("aws-cpi"))
})

By("writing create-env and delete-env scripts", func() {
expectedArgs := []string{
fmt.Sprintf("%s/jumpbox.yml", relativeDeploymentDir),
"--state", fmt.Sprintf("%s/jumpbox-state.json", relativeVarsDir),
"--vars-store", fmt.Sprintf("%s/jumpbox-vars-store.yml", relativeVarsDir),
"--vars-file", fmt.Sprintf("%s/jumpbox-vars-file.yml", relativeVarsDir),
"-o", fmt.Sprintf("%s/aws/cpi.yml", relativeDeploymentDir),
"-v", `access_key_id="${BBL_AWS_ACCESS_KEY_ID}"`,
"-v", `secret_access_key="${BBL_AWS_SECRET_ACCESS_KEY}"`,
}

expectedScript := formatScript("create-env", stateDir, expectedArgs)
scriptPath := fmt.Sprintf("%s/create-jumpbox.sh", stateDir)
shellScript, err := fs.ReadFile(scriptPath)
Expect(err).NotTo(HaveOccurred())

fileinfo, err := fs.Stat(scriptPath)
Expect(err).NotTo(HaveOccurred())
Expect(fileinfo.Mode().String()).To(Equal("-rwxr-x---"))
Expect(string(shellScript)).To(Equal(expectedScript))

expectedScript = formatScript("delete-env", stateDir, expectedArgs)
scriptPath = fmt.Sprintf("%s/delete-jumpbox.sh", stateDir)
shellScript, err = fs.ReadFile(scriptPath)
Expect(err).NotTo(HaveOccurred())

fileinfo, err = fs.Stat(scriptPath)
Expect(err).NotTo(HaveOccurred())
Expect(fileinfo.Mode().String()).To(Equal("-rwxr-x---"))
Expect(err).NotTo(HaveOccurred())
Expect(string(shellScript)).To(Equal(expectedScript))
})
})

By("writing create-env and delete-env scripts", func() {
expectedArgs := []string{
fmt.Sprintf("%s/jumpbox.yml", relativeDeploymentDir),
"--state", fmt.Sprintf("%s/jumpbox-state.json", relativeVarsDir),
"--vars-store", fmt.Sprintf("%s/jumpbox-vars-store.yml", relativeVarsDir),
"--vars-file", fmt.Sprintf("%s/jumpbox-vars-file.yml", relativeVarsDir),
"-o", fmt.Sprintf("%s/aws/cpi.yml", relativeDeploymentDir),
"-v", `access_key_id="${BBL_AWS_ACCESS_KEY_ID}"`,
"-v", `secret_access_key="${BBL_AWS_SECRET_ACCESS_KEY}"`,
}
Context("when assume role is set", func() {
It("writes create-env and delete-env scripts with the assume role ops files and variables", func() {
state := storage.State{
AWS: storage.AWS{
AssumeRoleArn: "some-aws-assume-role",
},
}
err := executor.PlanJumpboxWithState(dirInput, deploymentDir, "aws", state)
Expect(err).NotTo(HaveOccurred())

expectedScript := formatScript("create-env", stateDir, expectedArgs)
scriptPath := fmt.Sprintf("%s/create-jumpbox.sh", stateDir)
shellScript, err := fs.ReadFile(scriptPath)
Expect(err).NotTo(HaveOccurred())
expectedArgs := []string{
fmt.Sprintf("%s/jumpbox.yml", relativeDeploymentDir),
"--state", fmt.Sprintf("%s/jumpbox-state.json", relativeVarsDir),
"--vars-store", fmt.Sprintf("%s/jumpbox-vars-store.yml", relativeVarsDir),
"--vars-file", fmt.Sprintf("%s/jumpbox-vars-file.yml", relativeVarsDir),
"-o", fmt.Sprintf("%s/aws/cpi.yml", relativeDeploymentDir),
"-o", fmt.Sprintf("%s/aws/cpi-assume-role-credentials.yml", relativeDeploymentDir),
"-v", `access_key_id="${BBL_AWS_ACCESS_KEY_ID}"`,
"-v", `secret_access_key="${BBL_AWS_SECRET_ACCESS_KEY}"`,
"-v", `role_arn="${BBL_AWS_ASSUME_ROLE}"`,
}

fileinfo, err := fs.Stat(scriptPath)
Expect(err).NotTo(HaveOccurred())
Expect(fileinfo.Mode().String()).To(Equal("-rwxr-x---"))
Expect(string(shellScript)).To(Equal(expectedScript))
expectedScript := formatScript("create-env", stateDir, expectedArgs)
scriptPath := fmt.Sprintf("%s/create-jumpbox.sh", stateDir)
shellScript, err := fs.ReadFile(scriptPath)
Expect(err).NotTo(HaveOccurred())

expectedScript = formatScript("delete-env", stateDir, expectedArgs)
scriptPath = fmt.Sprintf("%s/delete-jumpbox.sh", stateDir)
shellScript, err = fs.ReadFile(scriptPath)
Expect(err).NotTo(HaveOccurred())
fileinfo, err := fs.Stat(scriptPath)
Expect(err).NotTo(HaveOccurred())
Expect(fileinfo.Mode().String()).To(Equal("-rwxr-x---"))
Expect(string(shellScript)).To(Equal(expectedScript))

fileinfo, err = fs.Stat(scriptPath)
Expect(err).NotTo(HaveOccurred())
Expect(fileinfo.Mode().String()).To(Equal("-rwxr-x---"))
Expect(err).NotTo(HaveOccurred())
Expect(string(shellScript)).To(Equal(expectedScript))
expectedScript = formatScript("delete-env", stateDir, expectedArgs)
scriptPath = fmt.Sprintf("%s/delete-jumpbox.sh", stateDir)
shellScript, err = fs.ReadFile(scriptPath)
Expect(err).NotTo(HaveOccurred())

fileinfo, err = fs.Stat(scriptPath)
Expect(err).NotTo(HaveOccurred())
Expect(fileinfo.Mode().String()).To(Equal("-rwxr-x---"))
Expect(err).NotTo(HaveOccurred())
Expect(string(shellScript)).To(Equal(expectedScript))
})
})
})

Expand Down Expand Up @@ -347,7 +394,7 @@ var _ = Describe("Executor", func() {
"-v", `secret_access_key="${BBL_AWS_SECRET_ACCESS_KEY}"`,
}

behavesLikePlan(expectedArgs, cli, fs, executor, dirInput, deploymentDir, "aws", stateDir)
behavesLikePlan(expectedArgs, cli, fs, executor, dirInput, deploymentDir, "aws", stateDir, storage.State{})
})

It("writes aws-specific ops files", func() {
Expand All @@ -364,6 +411,35 @@ var _ = Describe("Executor", func() {
value: true
`))
})

Context("when assume role is set", func() {
It("writes create-director.sh and delete-director.sh including the assume role ops files and variables", func() {
expectedArgs := []string{
filepath.Join(relativeDeploymentDir, "bosh.yml"),
"--state", filepath.Join(relativeVarsDir, "bosh-state.json"),
"--vars-store", filepath.Join(relativeVarsDir, "director-vars-store.yml"),
"--vars-file", filepath.Join(relativeVarsDir, "director-vars-file.yml"),
"-o", filepath.Join(relativeDeploymentDir, "aws", "cpi.yml"),
"-o", filepath.Join(relativeDeploymentDir, "jumpbox-user.yml"),
"-o", filepath.Join(relativeDeploymentDir, "uaa.yml"),
"-o", filepath.Join(relativeDeploymentDir, "credhub.yml"),
"-o", filepath.Join(relativeStateDir, "bbl-ops-files", "aws", "bosh-director-ephemeral-ip-ops.yml"),
"-o", filepath.Join(relativeDeploymentDir, "aws", "iam-instance-profile.yml"),
"-o", filepath.Join(relativeDeploymentDir, "aws", "encrypted-disk.yml"),
"-o", filepath.Join(relativeDeploymentDir, "aws", "cpi-assume-role-credentials.yml"),
"-v", `access_key_id="${BBL_AWS_ACCESS_KEY_ID}"`,
"-v", `secret_access_key="${BBL_AWS_SECRET_ACCESS_KEY}"`,
"-v", `role_arn="${BBL_AWS_ASSUME_ROLE}"`,
}

state := storage.State{
AWS: storage.AWS{
AssumeRoleArn: "some-aws-assume-role",
},
}
behavesLikePlan(expectedArgs, cli, fs, executor, dirInput, deploymentDir, "aws", stateDir, state)
})
})
})

Context("gcp", func() {
Expand All @@ -383,7 +459,7 @@ var _ = Describe("Executor", func() {
"-v", `zone="${BBL_GCP_ZONE}"`,
}

behavesLikePlan(expectedArgs, cli, fs, executor, dirInput, deploymentDir, "gcp", stateDir)
behavesLikePlan(expectedArgs, cli, fs, executor, dirInput, deploymentDir, "gcp", stateDir, storage.State{})
})

It("writes gcp-specific ops files", func() {
Expand Down Expand Up @@ -419,7 +495,7 @@ var _ = Describe("Executor", func() {
"-v", `tenant_id="${BBL_AZURE_TENANT_ID}"`,
}

behavesLikePlan(expectedArgs, cli, fs, executor, dirInput, deploymentDir, "azure", stateDir)
behavesLikePlan(expectedArgs, cli, fs, executor, dirInput, deploymentDir, "azure", stateDir, storage.State{})
})
})

Expand All @@ -439,7 +515,7 @@ var _ = Describe("Executor", func() {
"-v", `vcenter_password="${BBL_VSPHERE_VCENTER_PASSWORD}"`,
}

behavesLikePlan(expectedArgs, cli, fs, executor, dirInput, deploymentDir, "vsphere", stateDir)
behavesLikePlan(expectedArgs, cli, fs, executor, dirInput, deploymentDir, "vsphere", stateDir, storage.State{})
})
})

Expand All @@ -458,7 +534,7 @@ var _ = Describe("Executor", func() {
"-v", `openstack_password="${BBL_OPENSTACK_PASSWORD}"`,
}

behavesLikePlan(expectedArgs, cli, fs, executor, dirInput, deploymentDir, "openstack", stateDir)
behavesLikePlan(expectedArgs, cli, fs, executor, dirInput, deploymentDir, "openstack", stateDir, storage.State{})
})
})
Context("cloudstack", func() {
Expand All @@ -476,7 +552,7 @@ var _ = Describe("Executor", func() {
"-v", `cloudstack_secret_access_key="${BBL_CLOUDSTACK_SECRET_ACCESS_KEY}"`,
}

behavesLikePlan(expectedArgs, cli, fs, executor, dirInput, deploymentDir, "cloudstack", stateDir)
behavesLikePlan(expectedArgs, cli, fs, executor, dirInput, deploymentDir, "cloudstack", stateDir, storage.State{})
})
})
})
Expand Down Expand Up @@ -1028,13 +1104,13 @@ type behavesLikePlanFs interface {
fileio.Stater
}

func behavesLikePlan(expectedArgs []string, cli *fakes.BOSHCLI, fs behavesLikePlanFs, executor bosh.Executor, input bosh.DirInput, deploymentDir, iaas, stateDir string) {
func behavesLikePlan(expectedArgs []string, cli *fakes.BOSHCLI, fs behavesLikePlanFs, executor bosh.Executor, input bosh.DirInput, deploymentDir, iaas, stateDir string, state storage.State) {
cli.RunStub = func(stdout io.Writer, workingDirectory string, args []string) error {
stdout.Write([]byte("some-manifest")) //nolint:errcheck
return nil
}

err := executor.PlanDirector(input, deploymentDir, iaas)
err := executor.PlanDirectorWithState(input, deploymentDir, iaas, state)
Expect(err).NotTo(HaveOccurred())
Expect(cli.RunCallCount()).To(Equal(0))

Expand Down
8 changes: 4 additions & 4 deletions bosh/manager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ type directorVars struct {
}

type executor interface {
PlanDirector(DirInput, string, string) error
PlanJumpbox(DirInput, string, string) error
PlanDirectorWithState(DirInput, string, string, storage.State) error
PlanJumpboxWithState(DirInput, string, string, storage.State) error
CreateEnv(DirInput, storage.State) (string, error)
DeleteEnv(DirInput, storage.State) error
WriteDeploymentVars(DirInput, string) error
Expand Down Expand Up @@ -107,7 +107,7 @@ func (m *Manager) InitializeJumpbox(state storage.State) error {
VarsDir: varsDir,
}

err = m.executor.PlanJumpbox(iaasInputs, deploymentDir, state.IAAS)
err = m.executor.PlanJumpboxWithState(iaasInputs, deploymentDir, state.IAAS, state)
if err != nil {
return fmt.Errorf("Jumpbox interpolate: %s", err)
}
Expand Down Expand Up @@ -186,7 +186,7 @@ func (m *Manager) InitializeDirector(state storage.State) error {
VarsDir: varsDir,
}

err = m.executor.PlanDirector(iaasInputs, directorDeploymentDir, state.IAAS)
err = m.executor.PlanDirectorWithState(iaasInputs, directorDeploymentDir, state.IAAS, state)
if err != nil {
return err
}
Expand Down
Loading
Loading