def push(tag, force, overwrite):
if force is None and shout('git status --porcelain'):
raise HokusaiError("Working directory is not clean. Aborting.")
if force is None and shout('git status --porcelain --ignored'):
raise HokusaiError("Working directory contains ignored files and/or directories. Aborting.")
ecr = ECR()
if not ecr.project_repository_exists():
raise HokusaiError("ECR repository %s does not exist... did you run `hokusai setup` for this project?" % config.project_name)
shout(ecr.get_login())
if tag is None:
tag = shout('git rev-parse HEAD').strip()
if overwrite is None and ecr.tag_exists(tag):
raise HokusaiError("Tag %s already exists in remote repository. Aborting." % tag)
docker_compose_yml = os.path.join(os.getcwd(), 'hokusai/common.yml')
shout("docker-compose -f %s -p hokusai build" % docker_compose_yml, print_output=True)
build = "hokusai_%s:latest" % config.project_name
shout("docker tag %s %s:%s" % (build, config.aws_ecr_registry, tag))
shout("docker push %s:%s" % (config.aws_ecr_registry, tag), print_output=True)
print_green("Pushed %s to %s:%s" % (build, config.aws_ecr_registry, tag))
shout("docker tag %s %s:%s" % (build, config.aws_ecr_registry, 'latest'))
shout("docker push %s:%s" % (config.aws_ecr_registry, 'latest'), print_output=True)
print_green("Pushed %s to %s:%s" % (build, config.aws_ecr_registry, 'latest'))
def push(tag, build, force, overwrite, skip_latest=False):
if force is None and shout('git status --porcelain'):
raise HokusaiError("Working directory is not clean. Aborting.")
if force is None and shout('git status --porcelain --ignored'):
raise HokusaiError("Working directory contains ignored files and/or directories. Aborting.")
ecr = ECR()
if not ecr.project_repo_exists():
raise HokusaiError("ECR repo %s does not exist... did you run `hokusai setup` for this project?" % config.project_name)
shout(ecr.get_login())
if tag is None:
tag = shout('git rev-parse HEAD').strip()
if overwrite is None and ecr.tag_exists(tag):
raise HokusaiError("Tag %s already exists in registry. Aborting." % tag)
if build:
Docker().build()
build_tag = "hokusai_%s:latest" % config.project_name
shout("docker tag %s %s:%s" % (build_tag, ecr.project_repo, tag))
shout("docker push %s:%s" % (ecr.project_repo, tag), print_output=True)
print_green("Pushed %s to %s:%s" % (build_tag, ecr.project_repo, tag), newline_after=True)
if skip_latest: return
shout("docker tag %s %s:%s" % (build_tag, ecr.project_repo, 'latest'))
shout("docker push %s:%s" % (ecr.project_repo, 'latest'), print_output=True)
print_green("Pushed %s to %s:%s" % (build_tag, ecr.project_repo, 'latest'), newline_after=True)
def gitdiff():
ecr = ECR()
staging_deployment = Deployment('staging')
staging_tag = staging_deployment.current_tag
if staging_tag is None:
raise HokusaiError("Could not find a tag for staging. Aborting.")
staging_tag = ecr.find_git_sha1_image_tag(staging_tag)
if staging_tag is None:
raise HokusaiError(
"Could not find a git SHA1 tag for tag %s. Aborting." %
staging_tag)
production_deployment = Deployment('production')
production_tag = production_deployment.current_tag
if production_tag is None:
raise HokusaiError("Could not find a tag for production. Aborting.")
production_tag = ecr.find_git_sha1_image_tag(production_tag)
if production_tag is None:
raise HokusaiError("Could not find a git SHA1 for tag %s. Aborting." %
production_tag)
print_green("Comparing %s to %s" % (production_tag, staging_tag))
for remote in shout('git remote').splitlines():
shout("git fetch %s" % remote)
shout("git diff %s %s" % (production_tag, staging_tag), print_output=True)
def gitlog():
ecr = ECR()
staging_deployment = Deployment('staging')
staging_tag = staging_deployment.current_tag
if staging_tag is None:
raise HokusaiError("Could not find a tag for staging. Aborting.")
staging_tag = ecr.find_git_sha1_image_tag(staging_tag)
if staging_tag is None:
raise HokusaiError(
"Could not find a git SHA1 tag for tag %s. Aborting." %
staging_tag)
production_deployment = Deployment('production')
production_tag = production_deployment.current_tag
if production_tag is None:
raise HokusaiError("Could not find a tag for production. Aborting.")
production_tag = ecr.find_git_sha1_image_tag(production_tag)
if production_tag is None:
raise HokusaiError("Could not find a git SHA1 for tag %s. Aborting." %
production_tag)
print_green("Comparing %s to %s" % (production_tag, staging_tag))
shout("git log --right-only %s..%s" % (production_tag, staging_tag),
print_output=True)
def promote(migration, constraint, git_remote, timeout):
ecr = ECR()
deploy_from = Deployment('staging')
tag = deploy_from.current_tag
if tag is None:
raise HokusaiError("Could not find a tag for staging. Aborting.")
tag = ecr.find_git_sha1_image_tag(tag)
if tag is None:
print_red("Could not find a git SHA1 for tag %s. Aborting." % tag)
return 1
if migration is not None:
print_green("Running migration '%s' on production..." % migration,
newline_after=True)
return_code = CommandRunner('production').run(tag,
migration,
constraint=constraint,
tty=False)
if return_code:
raise HokusaiError("Migration failed with return code %s" %
return_code,
return_code=return_code)
deploy_to = Deployment('production').update(tag, constraint, git_remote,
timeout)
print_green("Promoted staging to production at %s" % tag)
def images(tag_exists, reverse_sort, limit, filter_tags, digests):
ecr = ECR()
if tag_exists:
if ecr.get_image_by_tag(tag_exists):
print_green(pick_yes())
return
else:
print_red(pick_no())
return 1
images = ecr.images
sorted_images = sorted(images,
key=itemgetter('imagePushedAt'),
reverse=not reverse_sort)
filtered_images = [
image for image in sorted_images if 'imageTags' in list(image.keys())
]
if filter_tags:
filtered_images = [
image for image in filtered_images
if filter_tags in ', '.join(image['imageTags'])
]
if digests:
print_green(
'Image Pushed At | Image Digest | Image Tags',
newline_before=True)
print_green(
'--------------------------------------------------------------------------------------------------------------------------------------'
)
else:
print_green('Image Pushed At | Image Tags',
newline_before=True)
print_green(
'----------------------------------------------------------')
for image in filtered_images[:limit]:
image_tags = ', '.join(image['imageTags'])
if digests:
line = "%s | %s | %s" % (image['imagePushedAt'],
image['imageDigest'], image_tags)
else:
line = "%s | %s" % (image['imagePushedAt'], image_tags)
if 'production' in image['imageTags']:
print_green(line)
elif 'staging' in image['imageTags']:
print_yellow(line)
else:
print_smart(line)
print_yellow("%d more images available" %
(len(filtered_images) - len(filtered_images[:limit])),
newline_before=True,
newline_after=True)
def gitcompare(org_name, git_compare_link):
ecr = ECR()
staging_tag = ecr.find_git_sha1_image_tag('staging')
if staging_tag is None:
raise HokusaiError("Could not find a tag for staging. Aborting.")
production_tag = ecr.find_git_sha1_image_tag('production')
if production_tag is None:
raise HokusaiError("Could not find a git SHA1 tag for production. Aborting.")
print_green(git_compare_link % (org_name, config.project_name, production_tag, staging_tag))
class TestECR(HokusaiIntegrationTestCase):
def setUp(self):
self.ecr = ECR()
@httpretty.activate
def test_registry(self):
httpretty.register_uri(httpretty.POST, "https://ecr.us-east-1.amazonaws.com/",
body=open(os.path.join(os.getcwd(), 'test', 'fixtures', 'ecr-repositories-response.json')).read(),
content_type="application/x-amz-json-1.1")
repositories = [str(repo['repositoryName']) for repo in self.ecr.registry()]
self.assertTrue('foo' in repositories)
self.assertTrue('bar' in repositories)
self.assertTrue('baz' in repositories)
@httpretty.activate
def test_project_repository_exists(self):
httpretty.register_uri(httpretty.POST, "https://ecr.us-east-1.amazonaws.com/",
body=open(os.path.join(os.getcwd(), 'test', 'fixtures', 'ecr-repositories-response.json')).read(),
content_type="application/x-amz-json-1.1")
self.assertTrue(self.ecr.project_repository_exists())
@httpretty.activate
def test_create_project_repository(self):
httpretty.register_uri(httpretty.POST, "https://ecr.us-east-1.amazonaws.com/",
body=open(os.path.join(os.getcwd(), 'test', 'fixtures', 'ecr-create-repository-response.json')).read(),
content_type="application/x-amz-json-1.1")
self.assertTrue(self.ecr.create_project_repository())
@httpretty.activate
def test_get_login(self):
httpretty.register_uri(httpretty.POST, "https://ecr.us-east-1.amazonaws.com/",
body=open(os.path.join(os.getcwd(), 'test', 'fixtures', 'ecr-authorization-response.json')).read(),
content_type="application/x-amz-json-1.1")
self.assertEqual(self.ecr.get_login(), 'docker login -u AWS -p 76W8YEUFHDSAE98DFDHSFSDFIUHSDAJKGKSADFGKDF https://123456789012.dkr.ecr.us-east-1.amazonaws.com')
@httpretty.activate
def test_get_images(self):
httpretty.register_uri(httpretty.POST, "https://ecr.us-east-1.amazonaws.com/",
body=open(os.path.join(os.getcwd(), 'test', 'fixtures', 'ecr-images-response.json')).read(),
content_type="application/x-amz-json-1.1")
self.assertEqual(self.ecr.get_images()[0]['imageTags'], ['7shdn4f0f34bb8shdkb313cbeccb2fc031808duho', 'latest'])
self.assertEqual(self.ecr.get_images()[0]['imageDigest'], 'sha256:8sh968hsn205e8bff53ba8ed1006c7f41dacd17db164efdn6d346204f997shdn')
self.assertEqual(self.ecr.get_images()[0]['registryId'], '123456789012')
self.assertEqual(self.ecr.get_images()[0]['repositoryName'], 'foo')
@httpretty.activate
def test_tag_exists(self):
httpretty.register_uri(httpretty.POST, "https://ecr.us-east-1.amazonaws.com/",
body=open(os.path.join(os.getcwd(), 'test', 'fixtures', 'ecr-images-response.json')).read(),
content_type="application/x-amz-json-1.1")
self.assertTrue(self.ecr.tag_exists('7shdn4f0f34bb8shdkb313cbeccb2fc031808duho'))
self.assertTrue(self.ecr.tag_exists('latest'))
def __init__(self, context, deployment_name=None, namespace=None):
self.context = context
self.namespace = namespace
self.kctl = Kubectl(self.context, namespace=namespace)
self.ecr = ECR()
if deployment_name:
self.cache = [
self.kctl.get_object("deployment %s" % deployment_name)
]
else:
self.cache = self.kctl.get_objects(
'deployment',
selector="app=%s,layer=application" % config.project_name)
def push(tag, build, force, overwrite, skip_latest=False):
if force is None and shout('git status --porcelain'):
raise HokusaiError("Working directory is not clean. Aborting.")
if force is None and shout('git status --porcelain --ignored'):
raise HokusaiError(
"Working directory contains ignored files and/or directories. Aborting."
)
ecr = ECR()
if not ecr.project_repo_exists():
raise HokusaiError(
"ECR repo %s does not exist... did you run `hokusai setup` for this project?"
% config.project_name)
shout(ecr.get_login())
if tag is None:
tag = shout('git rev-parse HEAD').strip()
if overwrite is None and ecr.tag_exists(tag):
raise HokusaiError("Tag %s already exists in registry. Aborting." %
tag)
if build:
docker_compose_yml = os.path.join(os.getcwd(), 'hokusai/build.yml')
legacy_docker_compose_yml = os.path.join(os.getcwd(),
'hokusai/common.yml')
if not os.path.isfile(docker_compose_yml) and not os.path.isfile(
legacy_docker_compose_yml):
raise HokusaiError("Yaml files %s / %s do not exist." %
(docker_compose_yml, legacy_docker_compose_yml))
if os.path.isfile(docker_compose_yml):
shout("docker-compose -f %s -p hokusai build" % docker_compose_yml,
print_output=True)
if os.path.isfile(legacy_docker_compose_yml):
shout("docker-compose -f %s -p hokusai build" %
legacy_docker_compose_yml,
print_output=True)
build_tag = "hokusai_%s:latest" % config.project_name
shout("docker tag %s %s:%s" % (build_tag, ecr.project_repo, tag))
shout("docker push %s:%s" % (ecr.project_repo, tag), print_output=True)
print_green("Pushed %s to %s:%s" % (build_tag, ecr.project_repo, tag))
if skip_latest: return
shout("docker tag %s %s:%s" % (build_tag, ecr.project_repo, 'latest'))
shout("docker push %s:%s" % (ecr.project_repo, 'latest'),
print_output=True)
print_green("Pushed %s to %s:%s" % (build_tag, ecr.project_repo, 'latest'))
def retag(tag_to_change, tag_to_match):
ecr = ECR()
if not ecr.project_repo_exists():
raise HokusaiError("Project repo does not exist. Aborting.")
try:
ecr.retag(tag_to_match, tag_to_change)
print_green(
"Updated ECR '%s' tag to point to the image that '%s' tag points to."
% (tag_to_change, tag_to_match),
newline_after=True)
except (ValueError, ClientError) as e:
raise HokusaiError("Updating ECR tag failed due to the error: '%s'" %
str(e))
class CommandRunner(object):
def __init__(self, context, namespace=None):
self.context = context
self.kctl = Kubectl(self.context, namespace=namespace)
self.ecr = ECR()
def run(self, image_tag, cmd, tty=None, env=(), constraint=()):
if not self.ecr.project_repo_exists():
raise HokusaiError("Project repo does not exist. Aborting.")
if os.environ.get('USER') is not None:
uuid = "%s-%s" % (os.environ.get('USER'), k8s_uuid())
else:
uuid = k8s_uuid()
name = "%s-hokusai-run-%s" % (config.project_name, uuid)
image_name = "%s:%s" % (self.ecr.project_repo, image_tag)
container = {
"args": cmd.split(' '),
"name": name,
"image": image_name,
"imagePullPolicy": "Always",
'envFrom': [{'configMapRef': {'name': "%s-environment" % config.project_name}}]
}
run_tty = tty if tty is not None else config.run_tty
if run_tty:
container.update({
"stdin": True,
"stdinOnce": True,
"tty": True
})
if env:
container['env'] = []
for s in env:
if '=' not in s:
raise HokusaiError("Error: environment variables must be of the form 'KEY=VALUE'")
split = s.split('=', 1)
container['env'].append({'name': split[0], 'value': split[1]})
spec = { "containers": [container] }
constraints = constraint or config.run_constraints
if constraints:
spec['nodeSelector'] = {}
for label in constraints:
if '=' not in label:
raise HokusaiError("Error: Node selectors must of the form 'key=value'")
split = label.split('=', 1)
spec['nodeSelector'][split[0]] = split[1]
overrides = { "apiVersion": "v1", "spec": spec }
if run_tty:
shout(self.kctl.command("run %s -t -i --image=%s --restart=Never --overrides=%s --rm" %
(name, image_name, pipes.quote(json.dumps(overrides)))), print_output=True)
else:
return returncode(self.kctl.command("run %s --attach --image=%s --overrides=%s --restart=Never --rm" %
(name, image_name, pipes.quote(json.dumps(overrides)))))
def gitlog():
ecr = ECR()
staging_tag = ecr.find_git_sha1_image_tag('staging')
if staging_tag is None:
raise HokusaiError("Could not find a tag for staging. Aborting.")
production_tag = ecr.find_git_sha1_image_tag('production')
if production_tag is None:
raise HokusaiError(
"Could not find a git SHA1 tag for production. Aborting.")
print_green("Comparing %s to %s" % (production_tag, staging_tag))
for remote in shout('git remote').splitlines():
shout("git fetch %s" % remote)
shout("git log --right-only %s..%s" % (production_tag, staging_tag),
print_output=True)
def k8s_create(context, tag='latest', namespace=None, filename=None):
if filename is None:
kubernetes_yml = os.path.join(CWD, HOKUSAI_CONFIG_DIR,
"%s.yml" % context)
else:
kubernetes_yml = filename
if not os.path.isfile(kubernetes_yml):
raise HokusaiError("Yaml file %s does not exist." % kubernetes_yml)
ecr = ECR()
if not ecr.project_repo_exists():
raise HokusaiError(
"ECR repository %s does not exist... did you run `hokusai setup` for this project?"
% config.project_name)
if not ecr.tag_exists(tag):
raise HokusaiError(
"Image tag %s does not exist... did you run `hokusai registry push`?"
% tag)
if tag is 'latest' and not ecr.tag_exists(context):
ecr.retag(tag, context)
print_green("Updated tag 'latest' -> %s" % context)
if filename is None:
configmap = ConfigMap(context, namespace=namespace)
configmap.create()
print_green("Created configmap %s-environment" % config.project_name)
kctl = Kubectl(context, namespace=namespace)
shout(kctl.command("create --save-config -f %s" % kubernetes_yml),
print_output=True)
print_green("Created Kubernetes environment %s" % kubernetes_yml)
def k8s_create(context, tag='latest', namespace=None, filename=None, environment=()):
if filename is None:
yaml_template = TemplateSelector().get(os.path.join(CWD, HOKUSAI_CONFIG_DIR, context))
else:
yaml_template = TemplateSelector().get(filename)
ecr = ECR()
if not ecr.project_repo_exists():
raise HokusaiError("ECR repository %s does not exist... did you run `hokusai setup` for this project?" % config.project_name)
if not ecr.tag_exists(tag):
raise HokusaiError("Image tag %s does not exist... did you run `hokusai registry push`?" % tag)
if tag == 'latest' and not ecr.tag_exists(context):
ecr.retag(tag, context)
print_green("Updated tag 'latest' -> %s" % context)
if filename is None:
configmap = ConfigMap(context, namespace=namespace)
for s in environment:
if '=' not in s:
raise HokusaiError("Error: environment variables must be of the form 'KEY=VALUE'")
split = s.split('=', 1)
configmap.update(split[0], split[1])
configmap.create()
print_green("Created configmap %s-environment" % config.project_name)
kctl = Kubectl(context, namespace=namespace)
yaml_spec = YamlSpec(yaml_template).to_file()
shout(kctl.command("create --save-config -f %s" % yaml_spec), print_output=True)
print_green("Created Kubernetes environment %s" % yaml_template)
def pull(tag, local_tag):
ecr = ECR()
if not ecr.project_repo_exists():
raise HokusaiError(
"ECR repo %s does not exist... did you run `hokusai setup` for this project?"
% config.project_name)
shout(ecr.get_login(),
mask=(r'^(docker login -u) .+ (-p) .+ (.+)$',
r'\1 ****** \2 ***** \3'))
shout("docker pull %s:%s" % (ecr.project_repo, tag))
shout("docker tag %s:%s hokusai_%s:%s" %
(ecr.project_repo, tag, config.project_name, local_tag))
print_green("Pulled %s:%s to hokusai_%s:%s" %
(ecr.project_repo, tag, config.project_name, local_tag),
newline_after=True)
def gitcompare(org_name, git_compare_link):
ecr = ECR()
staging_deployment = Deployment('staging')
staging_tag = staging_deployment.current_tag
if staging_tag is None:
raise HokusaiError("Could not find a tag for staging. Aborting.")
staging_tag = ecr.find_git_sha1_image_tag(staging_tag)
if staging_tag is None:
raise HokusaiError(
"Could not find a git SHA1 tag for tag %s. Aborting." %
staging_tag)
production_deployment = Deployment('production')
production_tag = production_deployment.current_tag
if production_tag is None:
raise HokusaiError("Could not find a tag for production. Aborting.")
production_tag = ecr.find_git_sha1_image_tag(production_tag)
if production_tag is None:
raise HokusaiError("Could not find a git SHA1 for tag %s. Aborting." %
production_tag)
print_green(git_compare_link %
(org_name, config.project_name, production_tag, staging_tag))
def environment_create(context):
kubernetes_yml = os.path.join(os.getcwd(), "hokusai/%s.yml" % context)
if not os.path.isfile(kubernetes_yml):
raise HokusaiError("Yaml file %s does not exist for given context." %
kubernetes_yml)
ecr = ECR()
if not ecr.project_repository_exists():
raise HokusaiError(
"ECR repository %s does not exist... did you run `hokusai setup` for this project?"
% config.project_name)
if not ecr.tag_exists('latest'):
raise HokusaiError(
"Image tag 'latest' does not exist... did you run `hokusai push`?")
if not ecr.tag_exists(context):
ecr.retag('latest', context)
print_green("Updated tag 'latest' -> %s" % context)
kctl = Kubectl(context)
shout(kctl.command("create --save-config -f %s" % kubernetes_yml),
print_output=True)
print_green("Created remote environment %s" % context)
class Deployment(object):
def __init__(self, context, deployment_name=None, namespace=None):
self.context = context
self.namespace = namespace
self.kctl = Kubectl(self.context, namespace=namespace)
self.ecr = ECR()
if deployment_name:
self.cache = [
self.kctl.get_object("deployment %s" % deployment_name)
]
else:
self.cache = self.kctl.get_objects(
'deployment',
selector="app=%s,layer=application" % config.project_name)
def update(self,
tag,
constraint,
git_remote,
timeout,
resolve_tag_sha1=True):
if not self.ecr.project_repo_exists():
raise HokusaiError("Project repo does not exist. Aborting.")
if resolve_tag_sha1:
tag = self.ecr.find_git_sha1_image_tag(tag)
if tag is None:
raise HokusaiError(
"Could not find a git SHA1 for tag %s. Aborting." % tag)
if self.namespace is None:
print_green("Deploying %s to %s..." % (tag, self.context),
newline_after=True)
else:
print_green("Deploying %s to %s/%s..." %
(tag, self.context, self.namespace),
newline_after=True)
if config.pre_deploy is not None:
print_green("Running pre-deploy hook '%s'..." % config.pre_deploy,
newline_after=True)
return_code = CommandRunner(self.context,
namespace=self.namespace).run(
tag,
config.pre_deploy,
constraint=constraint,
tty=False)
if return_code:
raise HokusaiError(
"Pre-deploy hook failed with return code %s" % return_code,
return_code=return_code)
deployment_timestamp = datetime.datetime.utcnow().strftime("%s%f")
for deployment in self.cache:
containers = [(container['name'], container['image'])
for container in deployment['spec']['template']
['spec']['containers']]
deployment_targets = [{
"name":
name,
"image":
"%s:%s" % (self.ecr.project_repo, tag)
} for name, image in containers if self.ecr.project_repo in image]
patch = {
"spec": {
"template": {
"metadata": {
"labels": {
"deploymentTimestamp": deployment_timestamp
}
},
"spec": {
"containers": deployment_targets
}
},
"progressDeadlineSeconds": timeout
}
}
print_green("Patching deployment %s..." %
deployment['metadata']['name'],
newline_after=True)
shout(
self.kctl.command(
"patch deployment %s -p '%s'" %
(deployment['metadata']['name'], json.dumps(patch))))
print_green("Waiting for deployment rollouts to complete...")
rollout_commands = [
self.kctl.command("rollout status deployment/%s" %
deployment['metadata']['name'])
for deployment in self.cache
]
return_codes = shout_concurrent(rollout_commands, print_output=True)
if any(return_codes):
print_red(
"One or more deployment rollouts timed out! Rolling back...",
newline_before=True,
newline_after=True)
rollback_commands = [
self.kctl.command("rollout undo deployment/%s" %
deployment['metadata']['name'])
for deployment in self.cache
]
shout_concurrent(rollback_commands, print_output=True)
raise HokusaiError("Deployment failed!")
post_deploy_success = True
if config.post_deploy is not None:
print_green("Running post-deploy hook '%s'..." %
config.post_deploy,
newline_after=True)
return_code = CommandRunner(self.context,
namespace=self.namespace).run(
tag,
config.post_deploy,
constraint=constraint,
tty=False)
if return_code:
print_yellow(
"WARNING: Running the post-deploy hook failed with return code %s"
% return_code,
newline_before=True,
newline_after=True)
print_yellow(
"The tag %s has been rolled out. However, you should run the post-deploy hook '%s' manually, or re-run this deployment."
% (tag, config.post_deploy),
newline_after=True)
post_deploy_success = False
if self.namespace is None:
deployment_tag = "%s--%s" % (
self.context,
datetime.datetime.utcnow().strftime("%Y-%m-%d--%H-%M-%S"))
print_green("Updating ECR deployment tags in %s..." %
self.ecr.project_repo,
newline_after=True)
try:
self.ecr.retag(tag, self.context)
print_green("Updated ECR tag %s -> %s" % (tag, self.context))
self.ecr.retag(tag, deployment_tag)
print_green("Updated ECR tag %s -> %s" % (tag, deployment_tag),
newline_after=True)
except (ValueError, ClientError) as e:
print_yellow(
"WARNING: Updating ECR deployment tags failed due to the error: '%s'"
% str(e),
newline_before=True,
newline_after=True)
print_yellow(
"The tag %s has been rolled out. However, you should create the ECR tags '%s' and '%s' manually, or re-run this deployment."
% (tag, deployment_tag, self.context),
newline_after=True)
post_deploy_success = False
remote = git_remote or config.git_remote
if remote is not None:
print_green("Pushing Git deployment tags to %s..." % remote,
newline_after=True)
try:
shout("git fetch %s" % remote)
shout("git tag -f %s %s" % (self.context, tag),
print_output=True)
shout("git tag -f %s %s" % (deployment_tag, tag),
print_output=True)
shout("git push -f --no-verify %s refs/tags/%s" %
(remote, self.context),
print_output=True)
print_green("Updated Git tag %s -> %s" %
(tag, self.context))
shout("git push -f --no-verify %s refs/tags/%s" %
(remote, deployment_tag),
print_output=True)
print_green("Updated Git tag %s -> %s" %
(tag, deployment_tag),
newline_after=True)
except CalledProcessError as e:
print_yellow(
"WARNING: Creating Git deployment tags failed due to the error: '%s'"
% str(e),
newline_before=True,
newline_after=True)
print_yellow(
"The tag %s has been rolled out. However, you should create the Git tags '%s' and '%s' manually, or re-run this deployment."
% (tag, deployment_tag, self.context),
newline_after=True)
post_deploy_success = False
if post_deploy_success:
print_green("Deployment succeeded!")
else:
raise HokusaiError("One or more post-deploy steps failed!")
def refresh(self):
deployment_timestamp = datetime.datetime.utcnow().strftime("%s%f")
for deployment in self.cache:
patch = {
"spec": {
"template": {
"metadata": {
"labels": {
"deploymentTimestamp": deployment_timestamp
}
}
}
}
}
print_green("Refreshing %s..." % deployment['metadata']['name'],
newline_after=True)
shout(
self.kctl.command(
"patch deployment %s -p '%s'" %
(deployment['metadata']['name'], json.dumps(patch))))
print_green("Waiting for refresh to complete...")
rollout_commands = [
self.kctl.command("rollout status deployment/%s" %
deployment['metadata']['name'])
for deployment in self.cache
]
return_codes = shout_concurrent(rollout_commands, print_output=True)
if any(return_codes):
raise HokusaiError("Refresh failed!")
@property
def names(self):
return [deployment['metadata']['name'] for deployment in self.cache]
@property
def current_tag(self):
images = []
for deployment in self.cache:
containers = deployment['spec']['template']['spec']['containers']
container_images = [
container['image'] for container in containers
if self.ecr.project_repo in container['image']
]
if not container_images:
raise HokusaiError(
"Deployment has no valid target containers. Aborting.")
if not all(x == container_images[0] for x in container_images):
raise HokusaiError(
"Deployment's containers do not reference the same image tag. Aborting."
)
images.append(container_images[0])
if not all(y == images[0] for y in images):
raise HokusaiError(
"Deployments do not reference the same image tag. Aborting.")
return images[0].rsplit(':', 1)[1]
def setup(project_name, template_remote, template_dir, template_vars,
allow_missing_vars):
mkpath(os.path.join(CWD, HOKUSAI_CONFIG_DIR))
config.create(clean_string(project_name))
ecr = ECR()
if ecr.project_repo_exists():
print_green("Project repo %s already exists. Skipping create." %
ecr.project_repo)
else:
ecr.create_project_repo()
print_green("Created project repo %s" % ecr.project_repo)
scratch_dir = None
if template_remote:
scratch_dir = tempfile.mkdtemp()
git_repo_and_branch = template_remote.split('#', 1)
git_repo = git_repo_and_branch[0]
if len(git_repo_and_branch) == 2:
git_branch = git_repo_and_branch[1]
else:
git_branch = "master"
shout("git clone -b %s --single-branch %s %s" %
(git_branch, git_repo, scratch_dir))
custom_template_dir = None
if allow_missing_vars:
environment_kwargs = {}
else:
environment_kwargs = {"undefined": StrictUndefined}
if scratch_dir and template_dir:
custom_template_dir = os.path.join(scratch_dir,
os.path.basename(template_dir))
env = Environment(loader=FileSystemLoader(
os.path.join(scratch_dir, os.path.basename(template_dir))),
**environment_kwargs)
elif scratch_dir:
custom_template_dir = scratch_dir
env = Environment(loader=FileSystemLoader(scratch_dir),
**environment_kwargs)
elif template_dir:
custom_template_dir = os.path.abspath(template_dir)
env = Environment(loader=FileSystemLoader(
os.path.abspath(template_dir)),
**environment_kwargs)
else:
try:
base_path = sys._MEIPASS
env = Environment(loader=FileSystemLoader(
os.path.join(base_path, 'hokusai', 'templates')))
except:
env = Environment(loader=PackageLoader('hokusai', 'templates'))
required_templates = [
'Dockerfile.j2', '.dockerignore.j2', 'hokusai/build.yml.j2',
'hokusai/development.yml.j2', 'hokusai/test.yml.j2',
'hokusai/staging.yml.j2', 'hokusai/production.yml.j2'
]
template_context = {
"project_name": config.project_name,
"project_repo": ecr.project_repo
}
for s in template_vars:
if '=' not in s:
raise HokusaiError(
"Error: template variables must be of the form 'key=value'")
split = s.split('=', 1)
template_context[split[0]] = split[1]
try:
for template in required_templates:
if custom_template_dir and not os.path.isfile(
os.path.join(custom_template_dir, template)):
raise HokusaiError("Could not find required template file %s" %
template)
with open(os.path.join(CWD, template.rstrip('.j2')), 'w') as f:
f.write(env.get_template(template).render(**template_context))
print_green("Created %s" % template.rstrip('.j2'))
if custom_template_dir:
for root, _, files in os.walk(custom_template_dir):
subpath = os.path.relpath(root, custom_template_dir)
if subpath is not '.':
mkpath(os.path.join(CWD, subpath))
for file in files:
if subpath is not '.':
file_path = os.path.join(subpath, file)
else:
file_path = file
if file_path in required_templates:
continue
if file_path.endswith('.j2'):
with open(os.path.join(CWD, file_path.rstrip('.j2')),
'w') as f:
f.write(
env.get_template(file_path).render(
**template_context))
else:
copyfile(os.path.join(custom_template_dir, file_path),
os.path.join(CWD, file_path))
print_green("Created %s" % file_path.rstrip('.j2'))
finally:
if scratch_dir:
rmtree(scratch_dir)
class Deployment(object):
def __init__(self, context, deployment_name=None, namespace=None):
self.context = context
self.namespace = namespace
self.kctl = Kubectl(self.context, namespace=namespace)
self.ecr = ECR()
if deployment_name:
self.cache = [
self.kctl.get_object("deployment %s" % deployment_name)
]
else:
self.cache = self.kctl.get_objects(
'deployment',
selector="app=%s,layer=application" % config.project_name)
def update(self,
tag,
constraint,
git_remote,
timeout,
update_config=False,
filename=None):
if not self.ecr.project_repo_exists():
raise HokusaiError("Project repo does not exist. Aborting.")
digest = self.ecr.image_digest_for_tag(tag)
if digest is None:
raise HokusaiError(
"Could not find an image digest for tag %s. Aborting." % tag)
if self.namespace is None:
print_green("Deploying %s to %s..." % (digest, self.context),
newline_after=True)
else:
print_green("Deploying %s to %s/%s..." %
(digest, self.context, self.namespace),
newline_after=True)
"""
This logic should be refactored, but essentially if namespace and filename are provided, the caller is
a review app, while if namespace is None it is either staging or production. If filename is unset for staging
or production it is targeting the 'canonical' app, i.e. staging.yml or production.yml while if it is set it is
trageting a 'canary' app.
For the canonical app, run deploy hooks and post-depoy steps creating deployment tags
For a canary app, skip deploy hooks and post-deploy steps
For review apps, run deploy hooks but skip post-deploy steps
For all deployment rollouts, if update_config or filename targets a yml file, bust the
deployment cache using k8s field selectors and get deployments to watch the rollout from
the yml file spec
"""
# Run the pre-deploy hook for the canonical app or a review app
if config.pre_deploy and (filename is None or
(filename and self.namespace)):
print_green("Running pre-deploy hook '%s'..." % config.pre_deploy,
newline_after=True)
return_code = CommandRunner(self.context,
namespace=self.namespace).run(
tag,
config.pre_deploy,
constraint=constraint,
tty=False)
if return_code:
raise HokusaiError(
"Pre-deploy hook failed with return code %s" % return_code,
return_code=return_code)
# Patch the deployments
deployment_timestamp = datetime.datetime.utcnow().strftime("%s%f")
if filename is None:
kubernetes_yml = os.path.join(CWD, HOKUSAI_CONFIG_DIR,
"%s.yml" % self.context)
else:
kubernetes_yml = filename
# If a review app, a canary app or the canonical app while updating config,
# bust the deployment cache and populate deployments from the yaml file
if filename or update_config:
self.cache = []
for item in yaml.safe_load_all(open(kubernetes_yml, 'r')):
if item['kind'] == 'Deployment':
self.cache.append(item)
# If updating config, path the spec and apply
if update_config:
print_green(
"Patching Deployments in spec %s with image digest %s" %
(kubernetes_yml, digest),
newline_after=True)
payload = []
for item in yaml.safe_load_all(open(kubernetes_yml, 'r')):
if item['kind'] == 'Deployment':
item['spec']['template']['metadata']['labels'][
'deploymentTimestamp'] = deployment_timestamp
item['spec']['progressDeadlineSeconds'] = timeout
for container in item['spec']['template']['spec'][
'containers']:
if self.ecr.project_repo in container['image']:
container['image'] = "%s@%s" % (
self.ecr.project_repo, digest)
payload.append(item)
f = NamedTemporaryFile(delete=False)
f.write(YAML_HEADER)
f.write(yaml.safe_dump_all(payload, default_flow_style=False))
f.close()
print_green("Applying patched spec %s..." % f.name,
newline_after=True)
try:
shout(self.kctl.command("apply -f %s" % f.name),
print_output=True)
finally:
os.unlink(f.name)
# If not updating config, patch the deployments in the cache and call kubectl patch to update
else:
for deployment in self.cache:
containers = [(container['name'], container['image'])
for container in deployment['spec']['template']
['spec']['containers']]
deployment_targets = [{
"name":
name,
"image":
"%s@%s" % (self.ecr.project_repo, digest)
} for name, image in containers
if self.ecr.project_repo in image]
patch = {
"spec": {
"template": {
"metadata": {
"labels": {
"deploymentTimestamp": deployment_timestamp
}
},
"spec": {
"containers": deployment_targets
}
},
"progressDeadlineSeconds": timeout
}
}
print_green("Patching deployment %s..." %
deployment['metadata']['name'],
newline_after=True)
shout(
self.kctl.command(
"patch deployment %s -p '%s'" %
(deployment['metadata']['name'], json.dumps(patch))))
# Watch the rollouts in the cache and if any fail, roll back
print_green("Waiting for deployment rollouts to complete...")
rollout_commands = [
self.kctl.command("rollout status deployment/%s" %
deployment['metadata']['name'])
for deployment in self.cache
]
return_codes = shout_concurrent(rollout_commands, print_output=True)
if any(return_codes):
print_red(
"One or more deployment rollouts failed! Rolling back...",
newline_before=True,
newline_after=True)
rollback_commands = [
self.kctl.command("rollout undo deployment/%s" %
deployment['metadata']['name'])
for deployment in self.cache
]
shout_concurrent(rollback_commands, print_output=True)
raise HokusaiError("Deployment failed!")
post_deploy_success = True
# Run the post-deploy hook for the canonical app or a review app
if config.post_deploy and (filename is None or
(filename and self.namespace)):
print_green("Running post-deploy hook '%s'..." %
config.post_deploy,
newline_after=True)
return_code = CommandRunner(self.context,
namespace=self.namespace).run(
tag,
config.post_deploy,
constraint=constraint,
tty=False)
if return_code:
print_yellow(
"WARNING: Running the post-deploy hook failed with return code %s"
% return_code,
newline_before=True,
newline_after=True)
print_yellow(
"The image digest %s has been rolled out. However, you should run the post-deploy hook '%s' manually, or re-run this deployment."
% (digest, config.post_deploy),
newline_after=True)
post_deploy_success = False
# For the canonical app, create tags
if filename is None:
deployment_tag = "%s--%s" % (
self.context,
datetime.datetime.utcnow().strftime("%Y-%m-%d--%H-%M-%S"))
print_green("Updating ECR deployment tags in %s..." %
self.ecr.project_repo,
newline_after=True)
try:
self.ecr.retag(tag, self.context)
print_green("Updated ECR tag %s -> %s" % (tag, self.context))
self.ecr.retag(tag, deployment_tag)
print_green("Updated ECR tag %s -> %s" % (tag, deployment_tag),
newline_after=True)
except (ValueError, ClientError) as e:
print_yellow(
"WARNING: Updating ECR deployment tags failed due to the error: '%s'"
% str(e),
newline_before=True,
newline_after=True)
print_yellow(
"The tag %s has been rolled out. However, you should create the ECR tags '%s' and '%s' manually, or re-run this deployment."
% (tag, deployment_tag, self.context),
newline_after=True)
post_deploy_success = False
remote = git_remote or config.git_remote
if remote:
print_green("Pushing Git deployment tags to %s..." % remote,
newline_after=True)
try:
shout("git fetch %s" % remote)
shout("git tag -f %s %s" % (self.context, tag),
print_output=True)
shout("git tag -f %s %s" % (deployment_tag, tag),
print_output=True)
shout("git push -f --no-verify %s refs/tags/%s" %
(remote, self.context),
print_output=True)
print_green("Updated Git tag %s -> %s" %
(tag, self.context))
shout("git push -f --no-verify %s refs/tags/%s" %
(remote, deployment_tag),
print_output=True)
print_green("Updated Git tag %s -> %s" %
(tag, deployment_tag),
newline_after=True)
except CalledProcessError as e:
print_yellow(
"WARNING: Creating Git deployment tags failed due to the error: '%s'"
% str(e),
newline_before=True,
newline_after=True)
print_yellow(
"The tag %s has been rolled out. However, you should create the Git tags '%s' and '%s' manually, or re-run this deployment."
% (tag, deployment_tag, self.context),
newline_after=True)
post_deploy_success = False
if post_deploy_success:
print_green("Deployment succeeded!")
else:
raise HokusaiError("One or more post-deploy steps failed!")
def refresh(self):
deployment_timestamp = datetime.datetime.utcnow().strftime("%s%f")
for deployment in self.cache:
patch = {
"spec": {
"template": {
"metadata": {
"labels": {
"deploymentTimestamp": deployment_timestamp
}
}
}
}
}
print_green("Refreshing %s..." % deployment['metadata']['name'],
newline_after=True)
shout(
self.kctl.command(
"patch deployment %s -p '%s'" %
(deployment['metadata']['name'], json.dumps(patch))))
print_green("Waiting for refresh to complete...")
rollout_commands = [
self.kctl.command("rollout status deployment/%s" %
deployment['metadata']['name'])
for deployment in self.cache
]
return_codes = shout_concurrent(rollout_commands, print_output=True)
if any(return_codes):
raise HokusaiError("Refresh failed!")
@property
def names(self):
return [deployment['metadata']['name'] for deployment in self.cache]
