@spotinst/spinnaker-deck

Version:

Spinnaker-Deck service, forked with support to Spotinst

github.com/spotinst/spinnaker-deck/tree/spot_provider

89 lines (86 loc) • 9.91 kB

text/typescript

import { HelpContentsRegistry } from '@spinnaker/core'; const helpContents: { [key: string]: string } = { 'ecs.loadBalancer.targetGroup': 'A target group is attached to an application / network load balancer and is a target for load balancer traffic. You need to create both the application load balancer and target groups prior to being able to use them in your pipeline.', 'ecs.serverGroup.clusterName': 'The name of the ECS cluster (group of underlying EC2 hosts) onto which your application will be deployed.Note that suggestions here are dependent on the selected account and region combination.', 'ecs.stage.findImageByTags.labelOrSha': "As of now, only Amazon's ECR is supported as a source docker repository.", 'ecs.serverGroup.stack': 'An environment variable available within your container, and on which you should base your application configuration at runtime. Typical values for this parameter are staging, prod, etc. Keep this parameter short!', 'ecs.serverGroup.detail': 'An environment variable available within your container, and on which you should base your application configuration at runtime. Typical values for this parameter are app, worker, migrator, etc. Keep this parameter short!', 'ecs.capacity.overwrite': "Checking this box will have the previous server group's capacity overwrite the new min, max and desired capacity parameters if a previous server group exists.", 'ecs.capacity.desired': 'The starting number of containers, before any autoscaling happens.', 'ecs.capacity.minimum': 'The minimum number of containers you can reach as a result of autoscaling. Typically, this represents the bare minimum you can afford to run without impacting your capacity to meet your SLA (Service Level Agreement) objectives', 'ecs.capacity.maximum': 'The maximal number of containers you can reach as a result of autoscaling.', 'ecs.capacity.reserved.computeUnits': 'The assured minimal amount of computing capacity your container will be able to use. 1024 units are equal to 1 AWS virtual CPU If other containers on your underlying host are not using their reserved compute capacity, this container will be able to use it.', 'ecs.capacity.reserved.memory': 'The maximal amount of memory that your container can use, in megabytes. Exceeding this amount may result in termination of your container.1024 mb = 1 gb', 'ecs.loadbalancing.targetPort': 'The port on which your application is listening for incoming traffic', 'ecs.iamrole': 'The IAM role that your container (task, in AWS wording) will inherit. Define a role only if your application needs to access AWS APIs', 'ecs.dockerimage': 'Docker image for your container, such as nginx:latest', 'ecs.dockerimagecredentials': 'The AWS Secrets Manager secret that contains private registry credentials.Define credentials only for private registries other than Amazon ECR.', 'ecs.placementConstraints': 'Rules for task placement. See <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html" target="_blank">AWS documentation</a> for more details. ', 'ecs.placementConstraintType': 'To ensure that each task in a particular group is running on a different container instance, use distinctInstance. To restrict the selection to a group of valid candidates, use memberOf. ', 'ecs.placementConstraintExpression': 'A cluster query language expression to apply to memberOf constraints. See <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html" target="_blank">AWS documentation</a> for more details.', 'ecs.placementStrategy': 'The strategy the container scheduler will be using. See <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html" target="_blank">AWS documentation</a> for more details. You should at least balance across availability zonesCustom placement strategies have not been implemented yet.', 'ecs.platformVersion': 'Defaults to the latest platform version.', 'ecs.capacity.copySourceScalingPoliciesAndActions': 'Copy Application Autoscaling policies and their associated alarms from the previous ECS service.', 'ecs.launchtype': 'Launch service tasks on your own EC2 instances or on Fargate.', 'ecs.healthgraceperiod': 'How long a container will be kept alive despite the load balancer health checks, in seconds.', 'ecs.publicip': 'Assign a public IP address to each task.', 'ecs.networkMode': 'awsvpc is the only networking mode that allows you to use Elastic Network Interfaces (ENI). The default value converts to Bridge on Linux, and NAT on Windows.', 'ecs.subnet': 'The subnet group(s) on which your server group will be deployed. All subnet groups selected must exist within the same VPC.', 'ecs.securityGroups': 'The security group(s) name(s) your containers are deployed with.', 'ecs.dockerLabels': 'Additional labels applied to your Docker container. This metadata can be used to identify your containers, or in conjunction with logging options. Maps directly to the <a href="https://docs.docker.com/engine/reference/commandline/run/#set-metadata-on-container--l---label---label-file">--label Docker flag</a>. Spinnaker will automatically add the spinnaker.servergroup, spinnaker.stack, spinnaker.detail labels for non-null values.', 'ecs.logDriver': 'The container\'s logging driver. This directly maps to the <a href="https://docs.docker.com/config/containers/logging/configure/#configure-the-default-logging-driver">--log-driver Docker flag.</a>', 'ecs.logOptions': 'A map of log options. This directly maps with the <a href="https://docs.docker.com/config/containers/logging/log_tags/">--log-opt Docker flag </a>', 'ecs.taskDefinition': 'The source of the ECS Task Definition. Task Definition contents can either be entering manually via input fields or from a selected JSON file artifact. Artifact file contents should be structured as an ECS "RegisterTaskDefinition" request.', 'ecs.taskDefinitionArtifact': 'The artifact containing the ECS Task Definition.', 'ecs.containerMappings': 'The list of expected containers within the Task Definition and which container image they should use. Containers in the Task Definition which are not specified here will be registered as they appear in the artifact.', 'ecs.containerMappingName': 'The name of the container. Name should match the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-name">containerDefinition.name</a> field as it appears in the Task Definition.', 'ecs.containerMappingImage': 'The container image the named container should run.', 'ecs.targetGroupMappings': 'The list of target groups through which the ECS service will receive load balancer traffic. Each target group is mapped to a container name and port within the Task Definition to specify which container should be registered to the target group.', 'ecs.loadBalancedContainer': 'The container in the Task Definition that should receive traffic from the load balancer. Required if a load balancer target group has been specified.', 'ecs.tags': 'The tags to apply to the task definition and the service', 'ecs.environmentVariables': 'The environment variable(s) your container are deployed with. SERVER_GROUP, CLOUD_STACK and CLOUD_DETAIL environment variables are used during deployment to identify the task and cannot be set here.', 'ecs.serviceDiscovery': 'The AWS Cloud Map service discovery registries to assign to this service', 'ecs.serviceDiscoveryRegistry': 'The AWS Cloud Map service to use for service discovery registration', 'ecs.serviceDiscoveryContainerPort': 'The port to be used for your service discovery service. Required only for services using bridge or host network mode, and for services using awsvpc network mode and a type SRV DNS record', 'ecs.serviceDiscoveryContainerName': 'The container name value, already specified in the task definition, to be used for your service discovery service.', 'ecs.computeOptions': 'Specify either a <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html" target="_blank">launch type</a> (default) or <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html" target="_blank">capacity providers</a> for running your ECS service.', 'ecs.capacityProviderStrategy': 'A capacity provider strategy gives you control over how your tasks use one or more capacity providers. See <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html#capacity-providers-concepts" target="_blank">AWS documentation</a> for more details. ', 'ecs.capacityProviderName': 'The short name of the capacity provider.', 'ecs.capacityProviderBase': 'Designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.', 'ecs.capacityProviderWeight': 'Designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.', }; Object.keys(helpContents).forEach((key) => HelpContentsRegistry.register(key, helpContents[key]));