@spotinst/spinnaker-deck

import { SETTINGS } from 'core/config/settings'; import { HelpContentsRegistry } from './helpContents.registry'; export interface IHelpContents { [key: string]: string; } const helpContents: { [key: string]: string } = { 'core.serverGroup.detail': '(Optional) Detail is a string of free-form alphanumeric characters and hyphens to describe any other variables in naming a cluster.', 'core.serverGroup.strategy': 'The deployment strategy tells Spinnaker what to do with the previous version of the server group.', 'cluster.search': ` Quickly filter the displayed server groups by the following fields: <ul> <li>Build # (e.g. <samp>#337</samp>)</li> <li>Jenkins host</li> <li>Jenkins job name</li> <li>Cluster (prefixed, e.g. <samp>cluster:myapp-int</samp>) <li>VPC (prefixed, e.g. <samp>vpc:main</samp>) <li>Clusters (comma-separated list, e.g. <samp>clusters:myapp-int, myapp-test</samp>) <li>Server Group Name</li> <li>Region</li> <li>Account</li> <li>Load Balancer Name</li> <li>Instance ID</li> <li>Labels (comma-separated list of key-value pairs that must all apply to entity, e.g. <samp>labels:app=spinnaker, source=prod</samp>)</li> </ul> You can search for multiple words or word fragments. For instance, to find all server groups in a prod stack with "canary" in the details, enter <samp>prod canary</samp>. To find a particular instance, enter the instance ID. Only the containing server group will be displayed, and the instance will be highlighted for you.`, 'loadBalancer.search': ` Quickly filter the displayed load balancers by the following fields: <ul> <li>VPC (prefixed, e.g. <samp>vpc:main</samp>) <li>Server Group Name</li> <li>Load Balancer Name</li> <li>Region</li> <li>Account</li> <li>Instance ID</li> </ul> You can search for multiple words or word fragments. For instance, to find all load balancers in a prod stack with "canary" in the details, enter <samp>prod canary</samp>.`, 'securityGroup.search': ` Filter by the following fields: <ul> <li>VPC (prefixed, e.g. <samp>vpc:main</samp>) <li>Name</li> <li>Server Group Name</li> <li>Load Balancer Name</li> <li>Region</li> <li>Account</li> </ul>`, 'executions.search': ` Quickly filter the displayed executions by the following fields: <ul> <li>Name</li> <li>Trigger</li> </ul>`, 'pipeline.config.triggers.respectQuietPeriod': ` The quiet period is a system operator designated period of time when automated pipelines and deploys should not run.`, 'pipeline.config.expectedArtifact': 'Artifacts required for trigger to execute. Only one of the artifacts needs to be present for the trigger to execute.', 'pipeline.config.artifact.help': ` There are certain types of triggers (e.g. Pub/Sub triggers) that can produce artifacts and inject them into the execution context for a pipeline. You can specify artifacts that your pipeline expects to be present in the execution context in this section.`, 'pipeline.config.artifact.missingPolicy': ` The behavior of the pipeline if the Artifact is missing from the pipeline execution.`, 'pipeline.config.artifact.name': ` The name of the Artifact.`, 'pipeline.config.artifact.type': ` The type of the Artifact, e.g. 'gcs/object' or 'rpm'.`, 'pipeline.config.lock.allowUnlockUi': ` Checked - the pipeline can be unlocked via the Spinnaker UI. Unchecked - the pipeline can only be unlocked via the Spinnaker API.`, 'pipeline.config.lock.description': ` Friendly description of why this pipeline is locked. Please include an email address or slack channel as appropriate.`, 'pipeline.config.optionalStage': ` When this option is enabled, stage will only execute when the supplied expression evaluates true. The expression does not need to be wrapped in \${ and }. If this expression evaluates to false, the stages following this stage will still execute.`, 'pipeline.config.checkPreconditions.failPipeline': ` Checked - the overall pipeline will fail whenever this precondition is false. Unchecked - the overall pipeline will continue executing but this particular branch will stop.`, 'pipeline.config.checkPreconditions.failureMessage': ` This failure message will be shown to the user if the precondition evaluates to false. `, 'pipeline.config.checkPreconditions.expectedSize': 'Number of server groups in the selected cluster', 'pipeline.config.checkPreconditions.expression': ` Value must evaluate to "true". Use of the Spring Expression Language allows for complex evaluations.`, 'pipeline.config.deploy.template': ` Select an existing cluster to use as a template for this deployment, and we'll pre-fill the configuration based on the newest server group in the cluster. If you want to start from scratch, select "None". You can always edit the cluster configuration after you've created it.`, 'pipeline.config.expectedArtifact.matchArtifact': ` This specifies which fields in your incoming artifact to match against. Every field that you supply will be used to match against all incoming artifacts. If all specified fields match, the incoming artifact is bound to your pipeline context. The field comparisons are done against the incoming artifact. Example: if you are parsing artifacts from pub/sub messages via a Jinja template, the comparison will be done after the pub/sub -> Spinnaker artifact translation. For example, if you want to match against any GCS object, only supply type = gcs/object. If you also want to restrict the matches by other fields, include those as well. Regex is accepted, so you could for example match on a filepath like so name = .*\\.yaml to match all incoming YAML files. See the <a href="https://www.spinnaker.io/reference/artifacts/in-pipelines/#expected-artifacts">reference</a> for more information.`, 'pipeline.config.expectedArtifact.ifMissing': ` If no artifact was supplied by your trigger to match against this expected artifact, you have a few options: <ol> <li>Attempt to match against an artifact in the prior pipeline execution's context. This ensures that you will always be using the most recently supplied artifact to this pipeline, and is generally a safe choice.</li> <li>If option 1 fails, or isn't specified, you can provide a default artifact with the required fields to use instead.</li> <li>Fail the pipeline if options 1 or 2 fail or aren't selected.</li> </ol> See the <a href="https://www.spinnaker.io/reference/artifacts/in-pipelines">reference</a> for more information.`, 'pipeline.config.expectedArtifact.usePriorExecution': ` Attempt to match against an artifact in the prior pipeline execution's context. This ensures that you will always be using the most recently supplied artifact to this pipeline, and is generally a safe choice.`, 'pipeline.config.expectedArtifact.defaultArtifact': ` If your artifact either wasn't supplied from a trigger, or it wasn't found in a prior execution, the artifact specified below will end up in your pipeline's execution context. See the <a href="https://www.spinnaker.io/reference/artifacts/in-pipelines">reference</a> for more information.`, 'pipeline.config.expectedArtifact.gcs.name': ` The GCS object name, in the form <code>gs://bucket/path/to/file.yml</code>.`, 'pipeline.config.expectedArtifact.defaultGcs.reference': ` The GCS object name, optionally appending the version. An example: <code>gs://bucket/file.yml#123948581</code>`, 'pipeline.config.expectedArtifact.s3.name': ` The S3 object name, in the form <code>s3://bucket/path/to/file.yml</code>.`, 'pipeline.config.expectedArtifact.defaultS3.reference': ` The S3 object name, optionally appending the version. An example: <code>s3://bucket/file.yml#123948581</code>`, 'pipeline.config.expectedArtifact.oracle.name': ` The Oracle object artifact name, in the form <code>oci://bucket/path/file.yml</code>.`, 'pipeline.config.expectedArtifact.defaultOracle.reference': ` The Oracle object artifact name, optionally appending the version. An example: <code>oci://bucket/file.yml#9ce463aa-d843-4438-b206-5365cd643e2e</code>`, 'pipeline.config.expectedArtifact.docker.name': ` The Docker image name you want to trigger on changes to. By default, this does not include the image tag or digest, only the registry and image repository.`, 'pipeline.config.expectedArtifact.defaultDocker.reference': ` The fully-qualified docker image to deploy. An example: <code>gcr.io/project/image@sha256:59bb771c86</code>`, 'pipeline.config.expectedArtifact.git.name': ` The file's path from the git root, in the form 'path/to/file.json'`, 'pipeline.config.expectedArtifact.defaultGithub.version': ` Either the commit or branch to checkout.`, 'pipeline.config.expectedArtifact.defaultGithub.reference': ` The GitHub API content url the artifact lives under. The domain name may change if you're running GHE. An example for GitHub.com is <code>https://api.github.com/repos/$ORG/$REPO/contents/$FILEPATH</code>. An example for GitHub Enterprise is <code>https://github.domain.com/api/v3/repos/$ORG/$REPO/contents/$FILEPATH</code>. See <a href="https://www.spinnaker.io/reference/artifacts/types/github-file/#fields">our docs</a> for more info.`, 'pipeline.config.expectedArtifact.defaultGitlab.version': ` Either the commit or branch to checkout.`, 'pipeline.config.expectedArtifact.defaultGitlab.reference': ` The Gitlab API file url the artifact lives under. The domain name may change if you're running your own Gitlab server. The repository and path to files must be URL encoded. An example is <code>https://gitlab.com/api/v4/projects/$ORG%2F$REPO/repository/files/path%2Fto%2Ffile.yml/raw</code>. See <a href="https://www.spinnaker.io/reference/artifacts/types/gitlab-file/#fields">our docs</a> for more info.`, 'pipeline.config.expectedArtifact.gitrepo.url': 'The location of your Git repository.', 'pipeline.config.expectedArtifact.gitrepo.branch': 'The branch of the repository you want to use.', 'pipeline.config.expectedArtifact.gitrepo.checkoutSubpath': 'Check this if you want to specify a subpath; doing so will reduce the size of the generated artifact.', 'pipeline.config.expectedArtifact.gitrepo.subpath': ` The subpath within the Git repository you desire to checkout. e.g.: examples/wordpress/mysql/`, 'pipeline.config.expectedArtifact.helm.account': ` The account contains url the charts can be found`, 'pipeline.config.expectedArtifact.helm.name': ` The name of chart you want to trigger on changes to`, 'pipeline.config.expectedArtifact.helm.version': ` The version of chart you want to trigger on changes to`, 'pipeline.config.expectedArtifact.defaultBitbucket.reference': ` The Bitbucket API file url the artifact lives under. The domain name may change if you're running your own Bitbucket server. The repository and path to files must be URL encoded. An example is <code>https://api.bitbucket.org/1.0/repositories/$ORG/$REPO/raw/$VERSION/$FILEPATH</code>. See <a href="https://www.spinnaker.io/reference/artifacts/types/bitbucket-file/#fields">our docs</a> for more info.`, 'pipeline.config.expectedArtifact.defaultBitbucket.filepath': ` The file path within your repo. path/to/file.yml is an example.`, 'pipeline.config.trigger.helm.chart': `The Helm chart name.`, 'pipeline.config.trigger.helm.version': `The Helm chart version, as semver.`, 'pipeline.config.trigger.helm.version.manual': `The Helm chart version, as an exact version.`, 'pipeline.config.trigger.webhook.source': ` Determines the target URL required to trigger this pipeline, as well as how the payload can be transformed into artifacts. `, 'pipeline.config.trigger.webhook.payloadConstraints': ` When provided, only a webhook with a payload containing at least the specified key/value pairs will be allowed to trigger this pipeline. For example, if you wanted to lock down the systems/users that can trigger this pipeline via this webhook, you could require the key "secret" and value "something-secret" as a constraint. The constraint values may be supplied as regex. `, 'pipeline.config.trigger.pubsub.attributeConstraints': ` Pubsub messages can have system-specific metadata accompanying the payload called attributes. When provided, only a pubsub message with attributes containing at least the specified key/value pairs will be allowed to trigger this pipeline. The constraint value is a java regex string. `, 'pipeline.config.trigger.pubsub.payloadConstraints': ` When provided, only a pubsub message with a payload containing at least the specified key/value pairs will be allowed to trigger this pipeline. For example, if you wanted to restrict the systems/users that can trigger this pipeline via this pubsub subscription, you could require the key "secret" and value "something-secret" as a constraint. The key/value pairs are matched against the unprocessed payload body, prior to any transformation using, for example, a Jinja template in a pubsub subscription configuration. The constraint value is a java regex string. `, 'pipeline.config.findArtifactFromExecution.considerExecutions': ` Select the types of executions to consider. When no selection is made, the default is "any execution". This will always evaluate to the most recent execution matching your provided criteria. `, 'pipeline.config.tags': `Pipeline tags let you filter pipelines/executions by addition dimensions in the executions page`, 'loadBalancer.advancedSettings.healthTimeout': 'Configures the timeout, in seconds, for reaching the healthCheck target. Must be less than the interval. Default: 5', 'loadBalancer.advancedSettings.idleTimeout': 'Configures the idle timeout, in seconds. If no data has been sent or received by the time that the idle timeout period elapses, the load balancer closes the connection. Default: 60', 'loadBalancer.advancedSettings.deletionProtection': 'To prevent your load balancer from being deleted accidentally, you can enable deletion protection. Default: false', 'loadBalancer.advancedSettings.healthInterval': 'Configures the interval, in seconds, between ELB health checks. Must be greater than the timeout.Default: 10', 'loadBalancer.advancedSettings.healthyThreshold': 'Configures the number of healthy observations before reinstituting an instance into the ELB’s traffic rotation.Default: 10', 'loadBalancer.advancedSettings.unhealthyThreshold': 'Configures the number of unhealthy observations before deservicing an instance from the ELB.Default: 2', 'loadBalancer.advancedSettings.loadBalancingCrossZone': 'Cross-zone load balancing distributes traffic evenly across all targets in the Availability Zones enabled for the load balancer. Default: True', 'loadBalancer.advancedSettings.albIpAddressType': 'Assigns both a v4 and v6 IP address to the load balancer. This option is only valid for an external load balancer. If left unchecked, this value will default to "ipv4".', 'loadBalancer.advancedSettings.nlbIpAddressType': 'Assigns both a v4 and v6 IP address to the load balancer. This option is only valid for NLBs which are external and only have Ip targets (not instance targets). If left unchecked, this value will default to "ipv4".', 'pipeline.config.resizeAsg.action': ` Configures the resize action for the target server group. <ul> <li>Scale Up increases the size of the target server group by an incremental or percentage amount</li> <li>Scale Down decreases the size of the target server group by an incremental or percentage amount</li> <li>Scale to Cluster Size increases the size of the target server group to match the largest server group in the cluster, optionally with an incremental or percentage additional capacity. Additional capacity will not exceed the existing maximum size.</li> <li>Scale to Exact Size adjusts the size of the target server group to match the provided capacity</li> </ul>`, 'pipeline.config.resizeAsg.cluster': 'Configures the cluster upon which this resize operation will act. The target specifies what server group to resolve for the operation.', 'pipeline.config.modifyScalingProcess.cluster': 'Configures the cluster upon which this modify scaling process operation will act. The target specifies what server group to resolve for the operation.', 'pipeline.config.enableAsg.cluster': 'Configures the cluster upon which this enable operation will act. The target specifies what server group to resolve for the operation.', 'pipeline.config.disableAsg.cluster': 'Configures the cluster upon which this disable operation will act. The target specifies what server group to resolve for the operation.', 'pipeline.config.destroyAsg.cluster': 'Configures the cluster upon which this destroy operation will act. The target specifies what server group to resolve for the operation.', 'pipeline.config.jenkins.trigger.propertyFile': '(Optional) Configures the name to the Jenkins artifact file used to pass in properties to later stages in the Spinnaker pipeline. The contents of this file will now be available as a map under the trigger and accessible via trigger.properties. See <a target="_blank" href="https://www.spinnaker.io/guides/user/pipeline-expressions/">Pipeline Expressions docs</a> for more information.', 'pipeline.config.jenkins.propertyFile': '(Optional) Configures the name to the Jenkins artifact file used to pass in properties to later stages in the Spinnaker pipeline. The contents of this file will now be available as a map under the stage context. See <a target="_blank" href="https://www.spinnaker.io/guides/user/pipeline-expressions/">Pipeline Expressions docs</a> for more information.', 'pipeline.config.travis.job.isFiltered': 'Note that for performance reasons, not all jobs are displayed. Please use the search field to limit the number of jobs.', 'pipeline.config.travis.trigger.propertyFile': '(Optional) Configures the name to the Travis artifact file used to pass in properties to later stages in the Spinnaker pipeline. The contents of this file will now be available as a map under the trigger and accessible via trigger.properties. See <a target="_blank" href="https://www.spinnaker.io/guides/user/pipeline-expressions/">Pipeline Expressions docs</a> for more information.', 'pipeline.config.travis.propertyFile': '(Optional) Configures the name to the Travis artifact file used to pass in properties to later stages in the Spinnaker pipeline. The contents of this file will now be available as a map under the stage context. See <a target="_blank" href="https://www.spinnaker.io/guides/user/pipeline-expressions/">Pipeline Expressions docs</a> for more information.', 'pipeline.config.bake.skipRegionDetection': ` By default, Spinnaker will detect regions to bake in from downstream deploy stages. To prevent failed deploys from accidentally missed regions during the bake process. This setting will disable this detection mechanism.`, 'pipeline.config.bake.package': ` The name of the package you want installed (without any version identifiers). If your build produces a deb file named "myapp_1.27-h343", you would want to enter "myapp" here. If there are multiple packages (space separated), then they will be installed in the order they are entered.`, 'pipeline.config.bake.packageArtifacts': ` Artifacts representing packages you want installed. These artifacts must be either deb or rpm packages, whichever applies to the operating system on your base image. Package artifacts are installed in order, after any packages in the 'Packages' field are installed.`, 'pipeline.config.docker.bake.targetImage': 'The name of the resulting docker image.', 'pipeline.config.docker.bake.targetImageTag': 'The tag of the resulting docker image, defaults to commit hash if available.', 'pipeline.config.docker.bake.organization': 'The name of the organization or repo to use for the resulting docker image.', 'pipeline.config.bake.baseAmi': '(Optional) If Base AMI is specified, this will be used instead of the Base OS provided', 'pipeline.config.bake.amiSuffix': '(Optional) String of date in format YYYYMMDDHHmm, default is calculated from timestamp,', 'pipeline.config.bake.amiName': '(Optional) Default = $package-$arch-$ami_suffix-$store_type', 'pipeline.config.bake.templateFileName': "(Optional) The explicit packer template to use, instead of resolving one from rosco's configuration.", 'pipeline.config.bake.varFileName': '(Optional) The name of a json file containing key/value pairs to add to the packer command.', 'pipeline.config.bake.extendedAttributes': '(Optional) Any additional attributes that you want to pass onto rosco, which will be injected into your packer runtime variables.', 'pipeline.config.manualJudgment.instructions': '(Optional) Instructions are shown to the user when making a manual judgment.May contain HTML.', 'pipeline.config.manualJudgment.propagateAuthentication': ` Checked - the pipeline will continue with the permissions of the approver. Unchecked - the pipeline will continue with its current permissions.`, 'pipeline.config.manualJudgment.judgmentInputs': ` (Optional) Entries populate a dropdown displayed when performing a manual judgment. The selected value can be used in a subsequent Check Preconditions stage to determine branching. For example, if the user selects "rollback" from this list of options, that branch can be activated by using the expression: <samp class="small">execution.stages[n].context.judgmentInput=="rollback"</samp>`, 'pipeline.config.bake.manifest.expectedArtifact': 'This is the template you want to render.', 'pipeline.config.bake.manifest.overrideExpressionEvaluation': 'Explicitly evaluate SpEL expressions in overrides just prior to manifest baking. Can be paired with the "Skip SpEL evaluation" option in the Deploy Manifest stage when baking a third-party manifest artifact with expressions not meant for Spinnaker to evaluate as SpEL.', 'pipeline.config.bake.manifest.templateRenderer': 'This is the engine used for rendering your manifest.', 'pipeline.config.bake.manifest.helm.chartFilePath': ` This is the relative path to the Chart.yaml file within your Git repo. e.g.: helm/my-chart/Chart.yaml`, 'pipeline.config.bake.manifest.helm.rawOverrides': 'Use --set instead of --set-string when injecting override values. Values injected using --set will be converted to primitive types by Helm.', 'pipeline.config.bake.manifest.kustomize.filePath': ` This is the relative path to the kustomization.yaml file within your Git repo. e.g.: examples/wordpress/mysql/kustomization.yaml`, 'pipeline.config.bake.cf.manifest.name': ' Name should be the same as the expected artifact in the Produces Artifact section. ', 'pipeline.config.bake.cf.manifest.templateArtifact': ` This is the manifest template needing resolution. Variables in this template should use double parentheses notation. e.g.: --- buildpack: ((javabuildpack)) foo: ((some.nestedKey)) `, 'pipeline.config.bake.cf.manifest.varsArtifact': ` These are the variables that will be substituted in the manifest template. These should be yaml files and follow standard convention. e.g.: --- javabuildpack: java_buildpack_offline some: nestedKey: bar `, 'pipeline.config.haltPipelineOnFailure': 'Immediately halts execution of all running stages and fails the entire execution.', 'pipeline.config.haltBranchOnFailure': 'Prevents any stages that depend on this stage from running, but allows other branches of the pipeline to run.', 'pipeline.config.haltBranchOnFailureFailPipeline': 'Prevents any stages that depend on this stage from running, but allows other branches of the pipeline to run. The pipeline will be marked as failed once complete.', 'pipeline.config.ignoreFailure': 'Continues execution of downstream stages, marking this stage as failed/continuing.', 'pipeline.config.jenkins.markUnstableAsSuccessful.true': 'If Jenkins reports the build status as UNSTABLE, Spinnaker will mark the stage as SUCCEEDED and continue execution of the pipeline.', 'pipeline.config.jenkins.markUnstableAsSuccessful.false': ` If Jenkins reports the build status as UNSTABLE, Spinnaker will mark the stage as FAILED; subsequent execution will be determined based on the configuration of the If build fails option for this stage.`, 'pipeline.config.travis.markUnstableAsSuccessful.true': 'If Travis reports the build status as UNSTABLE, Spinnaker will mark the stage as SUCCEEDED and continue execution of the pipeline.', 'pipeline.config.travis.markUnstableAsSuccessful.false': ` If Travis reports the build status as UNSTABLE, Spinnaker will mark the stage as TERMINAL; subsequent execution will be determined based on the configuration of the If build fails option for this stage.`, 'pipeline.config.wercker.markUnstableAsSuccessful.true': 'If Wercker reports the build status as UNSTABLE, Spinnaker will mark the stage as SUCCEEDED and continue execution of the pipeline.', 'pipeline.config.wercker.markUnstableAsSuccessful.false': ` If Wercker reports the build status as UNSTABLE, Spinnaker will mark the stage as FAILED; subsequent execution will be determined based on the configuration of the If build fails option for this stage.`, 'pipeline.config.cron.expression': 'Format (Year is optional)<samp>Seconds Minutes Hour DayOfMonth Month DayOfWeek (Year)</samp>' + 'Example: every 30 minutes<samp>0 0/30 * * * ?</samp>' + 'Example: every Monday at 10 am<samp>0 0 10 ? * 2</samp>' + 'Note: values for "DayOfWeek" are 1-7, where Sunday is 1, Monday is 2, etc. You can also use MON,TUE,WED, etc.', 'cluster.rollback.explicit': ` A server group running the previous build will be enabled and appropriately resized. The current server group will be disabled after the resize completes. `, 'cluster.rollback.previous_image': ` The current server group will be cloned with the previous build. `, 'pipeline.config.findAmi.cluster': 'The cluster to look at when selecting the image to use in this pipeline.', 'pipeline.config.findAmi.imageNamePattern': 'A regex used to match the name of the image. Must result in exactly one match to succeed. Empty is treated as match any.', 'pipeline.config.dependsOn': 'Declares which stages must be run before this stage begins.', 'pipeline.config.parallel.cancel.queue': 'If concurrent pipeline execution is disabled, then the pipelines that are in the waiting queue will get canceled when the next execution starts. Check this box if you want to keep them in the queue.', 'pipeline.config.timeout': ` Allows you to force the stage to fail if its running time exceeds a specific length. Note: By default, Spinnaker will use sensible timeouts that depend on the stage type and the operations the stage needs to perform at runtime. These defaults can vary based on chosen configuration and other external factors. `, 'pipeline.config.trigger.runAsUser': "The current user must have access to the specified service account, and the service account must have access to the current application. Otherwise, you'll receive an 'Access is denied' error.", 'pipeline.config.trigger.authorizedUser': "The current user must have the permission to approve the manual judgment stage. Otherwise, you'll not be able continue to the next pipeline stage.", 'pipeline.config.script.repoUrl': 'Path to the repo hosting the scripts in Stash. (e.g. <samp>CDL/mimir-scripts</samp>). Leave empty to use the default.', 'pipeline.config.script.repoBranch': 'Git Branch. (e.g. <samp>master</samp>). Leave empty to use the master branch.', 'pipeline.config.script.path': 'Path to the folder hosting the scripts in Stash. (e.g. <samp>groovy</samp>, <samp>python</samp> or <samp>shell</samp>)', 'pipeline.config.script.command': 'Executable script and parameters. (e.g. <samp>script.py --ami-id ${deploymentDetails[0].ami}</samp> ) ', 'pipeline.config.script.image': '(Optional) image passed down to script execution as IMAGE_ID', 'pipeline.config.script.account': '(Optional) account passed down to script execution as ENV_PARAM', 'pipeline.config.script.region': '(Optional) region passed down to script execution as REGION_PARAM', 'pipeline.config.script.cluster': '(Optional) cluster passed down to script execution as CLUSTER_PARAM', 'pipeline.config.script.cmc': '(Optional) cmc passed down to script execution as CMC', 'pipeline.config.script.propertyFile': '(Optional) The name to the properties file produced by the script execution to be used by later stages of the Spinnaker pipeline. ', 'pipeline.config.docker.trigger.tag': '(Optional) If specified, only the tags that match this Java Regular Expression will be triggered. Leave empty to trigger builds on any tag pushed.Builds will not be triggered off the latest tag or updates to existing tags.', 'pipeline.config.docker.trigger.digest': 'The SHA256 hash of the image.', 'pipeline.config.git.trigger.branch': '(Optional) If specified, only pushes to the branches that match this Java Regular Expression will be triggered. Leave empty to trigger builds for every branch.', 'pipeline.config.git.trigger.githubSecret': '(Optional, but recommended) If specified, verifies GitHub as the sender of this trigger. See <a target="_blank" href="https://developer.github.com/webhooks/securing/">GitHub docs</a> for more information.', 'serverGroupCapacity.useSourceCapacityTrue': ` Spinnaker will use the current capacity of the existing server group when deploying a new server group. This setting is intended to support a server group with auto-scaling enabled, where the bounds and desired capacity are controlled by an external process. In the event that there is no existing server group, the deploy will fail.`, 'serverGroupCapacity.useSourceCapacityFalse': 'The specified capacity is used regardless of the presence or size of an existing server group.', 'strategy.redblack.scaleDown': ` Resizes the target server group to zero instances before disabling it. Select this if you wish to retain the launch configuration for the old server group without running any instances.`, 'strategy.redblack.maxRemainingAsgs': ` Optional: indicates the maximum number of server groups that will remain in this cluster - including the newly created one. If you wish to destroy all server groups except the newly created one, select "Highlander" as the strategy. Minimum value: 2`, 'strategy.redblack.rollback': ` Disable the new server group and ensure that the previous server group is restored to its original capacity. The rollback will only be initiated if instances in the new server group fail to launch and become healthy. Should an error occur disabling or destroying other server groups in the cluster, the new server group will not be rolled back. `, 'strategy.rollingPush.relaunchAll': 'Incrementally terminates each instance in the server group, waiting for a new one to come up before terminating the next one.', 'strategy.rollingPush.totalRelaunches': 'Total number of instances to terminate and relaunch.', 'strategy.rollingPush.concurrentRelaunches': 'Number of instances to terminate and relaunch at a time.', 'strategy.rollingPush.concurrentRelaunches.migration': ` Number of instances to terminate and relaunch at a time. Can be expressed as an explicit instance count or as a percentage of instances in server group being migrated. `, 'strategy.rollingPush.order': ` Determines the order in which instances will be terminated. <ul><li>Oldest will terminate the oldest instances first</li> <li>Newest will terminate those most recently launched.</li></ul>`, 'strategy.rollingRedBlack.targetPercentages': 'Rolling red black will slowly scale up the new server group. It will resize the new server group by each percentage defined.', 'strategy.rollingRedBlack.rollback': 'Disable the new server group and ensure that the previous server group is restored to its original capacity.', 'strategy.monitored.deploySteps': 'Monitored Deploy will scale up the new server group as specified by these per cent steps. After each step, the health of the new server group will be evaluated by the specified deployment monitor.', 'strategy.monitored.rollback': 'If deploy fails, disable the new server group and ensure that the previous server group is active and restored to its original capacity.', 'strategy.monitored.destroyFailedAsg': 'If deploy fails and rollback succeeds destroys the server group that failed the deploy instead of just disabling it.', 'loadBalancers.filter.serverGroups': ` Displays all server groups configured to use the load balancer. If the server group is configured to not add new instances to the load balancer, it will be grayed out.`, 'loadBalancers.filter.instances': ` Displays all instances in the context of their parent server group. The color of the instance icon indicates only its health in relation to the load balancer. That is, if the load balancer health check reports the instance as healthy, the instance will appear green - even if other health indicators (Discovery, other load balancers, etc.) report the instance as unhealthy. A red icon indicates the instance is failing the health check for the load balancer. A gray icon indicates the instance is currently detached from the load balancer.`, 'loadBalancers.filter.onlyUnhealthy': ` Filters the list of load balancers and server groups (if enabled) to only show load balancers with instances failing the health check for the load balancer.`, 'project.cluster.stack': '(Optional field)Filters displayed clusters by stack.Enter <samp>*</samp> to include all stacks; leave blank to omit any clusters with a stack.Only <samp>*</samp> is valid for Kubernetes V2 accounts.', 'project.cluster.detail': '(Optional field)Filters displayed clusters by detail.Enter <samp>*</samp> to include all details; leave blank to omit any clusters with a detail.Only <samp>*</samp> is valid for Kubernetes V2 accounts.', 'instanceType.storageOverridden': 'These storage settings have been cloned from the base server group and differ from the default settings for this instance type.', 'instanceType.unavailable': 'This instance type is not available for the selected configuration.', 'execution.forceRebake': ` By default, the bakery will not create a new image if the contents of the package and base image have not changed. Instead, it will return the previously baked image, though this behavior is not guaranteed. Select this option to force the bakery to create a new image, regardless of whether or not a matching image exists.`, 'execution.dryRun': ` Select this option to run the pipeline without really executing anything. This is a good way to test parameter-driven behavior, expressions, optional stages, etc.`, 'user.verification': ` Typing into this verification field is annoying! But it serves as a reminder that you are changing something in an account deemed important, and prevents you from accidentally changing something when you meant to click on the "Cancel" button.`, 'pipeline.waitForCompletion': 'if unchecked, marks the stage as successful right away without waiting for the pipeline to complete', 'jenkins.waitForCompletion': 'if unchecked, marks the stage as successful right away without waiting for the Jenkins job to complete', 'travis.waitForCompletion': 'if unchecked, marks the stage as successful right away without waiting for the Travis job to complete', 'wercker.waitForCompletion': 'if unchecked, marks the stage as successful right away without waiting for the Wercker job to complete', 'script.waitForCompletion': 'if unchecked, marks the stage as successful right away without waiting for the script to complete', // eslint-disable-next-line no-useless-escape 'markdown.examples': ` Some examples of markdown syntax: \`*italic*\` \`**bold**\` \`[link text](http://url-goes-here)\` `, 'pipeline.config.webhook.payload': 'JSON payload to be added to the webhook call.', 'pipeline.config.webhook.cancelPayload': 'JSON payload to be added to the webhook call when it is called in response to a cancellation.', 'pipeline.config.webhook.waitForCompletion': 'If not checked, we consider the stage succeeded if the webhook returns an HTTP status code 2xx, otherwise it will be failed. If checked, it will poll a status url (defined below) to determine the progress of the stage.', 'pipeline.config.webhook.statusUrlResolutionIsGetMethod': "Use the webhook's URL with GET method as status endpoint.", 'pipeline.config.webhook.statusUrlResolutionIsLocationHeader': "Pick the status url from the Location header of the webhook's response call.", 'pipeline.config.webhook.statusUrlResolutionIsWebhookResponse': "Pick the status url from the JSON returned by the webhook's response call.", 'pipeline.config.webhook.statusUrlJsonPath': "JSON path to the status url in the webhook's response JSON. (i.e. <samp>$.buildInfo.url</samp>)", 'pipeline.config.webhook.retryStatusCodes': 'Normally, webhook stages only retry on 429 and 5xx status codes. You can specify additional status codes here that will cause the monitor to retry (e.g. <samp>404, 418</samp>)', 'pipeline.config.webhook.waitBeforeMonitor': 'Optional delay (in seconds) to wait before starting to poll the endpoint for monitoring status', 'pipeline.config.webhook.statusJsonPath': "JSON path to the status information in the webhook's response JSON (e.g. <samp>$.buildInfo.status</samp>). If left empty, a 200 response from the status endpoint will be treated as a success.", 'pipeline.config.webhook.progressJsonPath': "JSON path to a descriptive message about the progress in the webhook's response JSON. (e.g. <samp>$.buildInfo.progress</samp>)", 'pipeline.config.webhook.successStatuses': 'Comma-separated list of strings (that will be returned in the response body in the previously defined `statusJsonPath` field) that will be considered as SUCCESS status.', 'pipeline.config.webhook.canceledStatuses': 'Comma-separated list of strings (that will be returned in the response body in the previously defined `statusJsonPath` field) that will be considered as CANCELED status.', 'pipeline.config.webhook.terminalStatuses': 'Comma-separated list of strings (that will be returned in the response body in the previously defined `statusJsonPath` field) that will be considered as TERMINAL status.', 'pipeline.config.webhook.customHeaders': 'Key-value pairs to be sent as additional headers to the service.', 'pipeline.config.webhook.failFastCodes': 'Comma-separated HTTP status codes (4xx or 5xx) that will cause this webhook stage to fail without retrying.', 'pipeline.config.webhook.signalCancellation': 'Trigger a specific webhook if this stage is cancelled by user or due to pipeline failure', 'pipeline.config.parameter.label': '(Optional): a label to display when users are triggering the pipeline manually', 'pipeline.config.parameter.description': `(Optional): if supplied, will be displayed to users as a tooltip when triggering the pipeline manually. You can include HTML in this field.`, 'pipeline.config.parameter.pinned': `(Optional): if checked, this parameter will be always shown in a pipeline execution view, otherwise it'll be collapsed by default.`, 'pipeline.config.parameter.pinAll': `(Optional): if checked, all parameters will be shown in a pipeline execution view.`, 'pipeline.config.failOnFailedExpressions': `When this option is enabled, the stage will be marked as failed if it contains any failed expressions`, 'pipeline.config.roles.help': ` When the pipeline is triggered using an automated trigger, these roles will be used to decide if the pipeline has permissions to access a protected application or account. <ul> <li> To read from a protected application or account, the pipeline must have at least one role that has read access to the application or account. </li> <li> To write to a protected application or account, the pipeline must have at least one role that has write access to the application or account. </li> </ul> Note: To prevent privilege escalation vulnerabilities, a user must be a member of all of the groups specified here in order to modify, and execute the pipeline.`, 'pipeline.config.entitytags.namespace': `All tags have an associated namespace (default will be used if unspecified) that provides a means of grouping tags by a logical owner.`, 'pipeline.config.entitytags.value': `Value can either be a string or an object. If you want to use an object, input a valid JSON string.`, 'pipeline.config.entitytags.region': `(Optional) Target a specific region, use * if you want to apply to all regions.`, 'pipeline.config.deliveryConfig.manifest': `(Optional) Name of the file with your Delivery Config manifest. Leave blank to use the default name (${SETTINGS.managedDelivery?.defaultManifest}).`, 'pipeline.config.codebuild.source': `(Optional) Source of the build. It will be overridden to Spinnaker artifact if checked. If not checked, source configured in CodeBuild project will be used.`, 'pipeline.config.codebuild.sourceType': `(Optional) Type of the source. It can be specified explicitly; otherwise, it will be inferred from source artifact.`, 'pipeline.config.codebuild.sourceVersion': `(Optional) Source version of the build. If not specified, the artifact version will be used. If artifact doesn't have a version, the latest version will be used. See the <a href="https://docs.aws.amazon.com/codebuild/latest/APIReference/API_StartBuild.html#CodeBuild-StartBuild-request-sourceVersion">CodeBuild reference</a> for more information.`, 'pipeline.config.codebuild.buildspec': `(Optional) Inline buildspec definition of the build. If not specified, buildspec configured in CodeBuild project will be used.`, 'pipeline.config.codebuild.secondarySources': `(Optional) Secondary sources of the build. It can be overridden by adding Spinnaker Artifacts. If not specified, secondary sources configured in CodeBuild project will be used.`, 'pipeline.config.codebuild.image': `(Optional) Image in which the build will run. It can be overridden by specifying the name of the image. If not specified, image configured in CodeBuild project will be used.`, 'pipeline.config.codebuild.envVar': `(Optional) Environment variables that will be propagated into the build.`, }; Object.keys(helpContents).forEach((key) => HelpContentsRegistry.register(key, helpContents[key]));