Spinnaker – Application User Guide

Docs: Configure an application

Mon, 01 Jan 0001 00:00:00 +0000

Once you’ve created an application , you can finish configuring it before adding infrastructure and pipelines.

Start configuring

From within the application, click CONFIG at the top right of the Spinnaker screen.

The application attributes you defined when you created the app are shown at the top.

Note Spinnaker can infer applications based on existing infrastructure. In these cases, there are no application attributes. For applications that you want to use as applications (as described in this guide) you’ll have to add the attributes.
If you want to change any of these attributes, click Edit Application Attributes.

Create pipeline notifications

Spinnaker can send notifications upon completion of certain types of pipeline activity. These notifications are optional.

Click Add Notification Preferences
Select the notification medium:
- email
- SMS
- Slack
Provide the information for the type you chose:
- email address
- Phone number
Choose each pipeline event that will trigger this notification:
- A pipeline started
- A pipeline finished
- A pipeline failed
For each event, enter any custom text you want included in the notification.

For example, for Any pipeline is complete you could enter “Congratulations, your pipeline has finished!” Custom notification text is optional.
Click Update
Repeat these steps to add more notifications, if you want.
Click Edit next to any existing notification to change its preferences, or click Remove to delete it.

Enable or disable application features

You can disable any of the main features available in your application, if you don’t need them. Disabling one of these features merely removes it from the Deck user interface; no existing data is deleted.

Simply de-select any of the features you don’t need:

pipelines
clusters
load balancers
firewalls

Add custom instance links

You can include custom links to the instance details panel, providing shortcuts to information related to the instance, like logs, health, and so on.

Note: Custom instance links don’t currently work for Kubernetes resources.

These links are resolved using the public IP address of the instance, if available, or the private IP otherwise. The default port is 80; if you want to use a different port, begin the path with :.

In the Links section, click Add Section.
Provide text for the new Section heading.
In the Links fields, type the text that you want to display, and the path to the link target.

You can reference these specific instance attributes by wrapping them in curly braces. For example, to include the region where the instance lives, for a GCE or AWS instance, use {region}. These are for the path only, not the link display text.
Click Add Link for each additional link you want displayed in this section.
Click Add Section for any additional sections.
Click Revert to clear your work in progress.

This does not remove any saved custom instance links.
Click Save Changes when you’re finished.

Note that you can set default links across all applications, as described here .

Refresh caches

Spinnaker keeps a local cache of resources. This section of application configuration merely gives you a way to refresh those caches.

Designate a traffic-guard cluster

A traffic guard is a cluster which you have designated as always having at least one active instance.

With traffic guard enabled, if a user or process tries to delete, disable, or resize the server group, Spinnaker will verify the operation will not leave the cluster with no active instances, and fail the operation if it would.

In the Traffic Guards section, click Add Traffic Guard.
Set the following values:

| Field | Required? | Description | | Account | Yes | The account for which you’re setting up the traffic guard| | Region | Yes | The applicable region from the list, or * for all| | Stack | No | The stack to which to apply this traffic guard. Leave blank to apply the guard only to a cluster that has no stack.| | Detail | No | The detail string necessary to identify this cluster via the application-stack-detail naming convention|
Click Save Changes to apply your new traffic guard, or changes to an existing one.

Docs: Create an application

Mon, 01 Jan 0001 00:00:00 +0000

You can’t create a deployment pipeline unless you have an application to put it in. If you’re accessing Spinnaker for the first time and there are no applications available, the first thing you’re going to do is create one.

From any screen, click on the Applications tab.

Note that there might be some applications there already. In some cases, Spinnaker creates applications automatically based on existing infrastructure.

These applications will be marked “unconfigured”; they won’t have the application attributes that are added when you create a new application. These inferred applications are not suitable for putting your pipelines in; go ahead and create a new one.
Click Actions, then Create Application.

Provide the application attributes in the New Application dialog.

Field	Required	Description
Name	Yes	A unique name to identify this application.
Owner Email	Yes	The email address of the owner of this application, within your installation of Spinnaker.
Repo type	No	The platform hosting the code repository for this application. Stash, Bitbucket, or GitHub.
Description	No	Use this text field to describe the application, if necessary.
Consider only cloud provider health	Bool, default=no	If enabled, instance status as reported by the cloud provider is considered sufficient to determine task completion. When disabled, tasks need health status reported by some other health provider (load balancer, discovery service).
Show health override option	Bool, default=no	If enabled, users can toggle previous option per task.
Instance port	No	This field is used to generate links from Spinnaker instance details to a running instance. The instance port can be used or overridden for specific links configured for your application (via the Config screen).
Enable restarting running pipelines	Bool, default=no	If enabled, users can restart pipeline stages while a pipeline is still running. This behavior is not recommended.

Click Create.

Next steps

You now have an application in which to start adding infrastructure and creating pipelines. These application attributes are the minimum configuration, but you will probably want to finish configuring the application .

Docs: Delete an application

Mon, 01 Jan 0001 00:00:00 +0000

If you have any server groups in this application, you need to delete them first.
From the Applications screen, open the application you want to delete.
Click CONFIG.
Scroll to the bottom of the application configuration screen, and click Delete Application.