{"__v":8,"_id":"56c14ca9f203270d00d6c546","category":{"__v":14,"_id":"55c6bec2b9aa4e0d0016c2c7","pages":["55c6bec3b9aa4e0d0016c2c9","55c8f451b79cb30d005b3e49","55ccea804906d12f001226e4","56c14ca9f203270d00d6c546","56c3bbeb2d97560d00e23ccf","56cce248ca43550b002814db","56cceaacd98d851d00c0c376","56cceefc723ad71d00cae46d","56ccef4e8fa8b01b00b8200e","56cd03e8723ad71d00cae4af","56cd03f2723ad71d00cae4b1","56cd061eca43550b0028151c","56cd07e4d98d851d00c0c3ba","56df35fbef8c1b320047c2d5"],"project":"55c6bec1b9aa4e0d0016c2c3","version":"55c6bec1b9aa4e0d0016c2c6","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-09T02:45:22.223Z","from_sync":false,"order":0,"slug":"documentation","title":"Guides"},"parentDoc":null,"project":"55c6bec1b9aa4e0d0016c2c3","user":"55c6b99c476be90d00500805","version":{"__v":8,"_id":"55c6bec1b9aa4e0d0016c2c6","project":"55c6bec1b9aa4e0d0016c2c3","createdAt":"2015-08-09T02:45:21.683Z","releaseDate":"2015-08-09T02:45:21.683Z","categories":["55c6bec2b9aa4e0d0016c2c7","56c14bc5826df10d00e82230","56cceed8723ad71d00cae46c","56ccf29a431ada1f00e85aae","56ccf3c28fa8b01b00b82018","56ce1e6ee538330b0021ac5d","56f97e9a4c612020008f2eaf","5734fafd146eb82000597261"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":["5748b1b7919ad20e00b6c791","5862ddb983cbbf1900cf75a6","5862ddb95a47fe1900565da8","5862ddbaba46b22d003937ef"],"next":{"pages":[],"description":""},"createdAt":"2016-02-15T03:57:29.648Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Spinnaker is an open source, multi-cloud continuous delivery platform for releasing software changes with high velocity and confidence.\n\nIt provides two core sets of features: *cluster management* and *deployment management*. Below we give a top-level overview of these features.\n\n## Cluster Management\n\nSpinnaker's cluster management features are used to manage resources in the cloud.\n\n* **Server Group**: The base resource to be managed is the *Server Group*. A Server Group identifies the machine instance profile on which to execute images along with the number of instances, and is associated with a Load Balancer and a Security Group. A Server Group is also identified with basic configuration settings, such as user account information and the region/zone in which images are deployed. When deployed, a Server Group is a collection of virtual machines running software.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/4l9kTko1SVSIcI26iBSR_server_group.png\",\n        \"server_group.png\",\n        \"506\",\n        \"316\",\n        \"#c92933\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n* **Security Group**: A *Security Group* defines network traffic access. It is effectively a set of firewall rules defined by an IP range (CIDR) along with a communication protocol (e.g., TCP) and port range.\n* **Load Balancer**: A *Load Balancer* is associated with an ingress protocol and port range, and balances traffic among instances in the corresponding Server Group. Optionally, you can enable health checks for a load balancer, with flexiblity to define health criteria and specify the health check endpoint.\n* **Cluster**: A *Cluster* is a user-defined, logical grouping of Server Groups in Spinnaker.\n\n## Deployment Management\n\nSpinnaker's deployment management features are used to construct and manage continuous delivery workflows.\n\n* **Pipeline**: *Pipelines* are the key deployment management construct in Spinnaker. They are defined by a sequence of stages, along with automated triggers (optional) that kick off the pipeline, parameters that get passed to all stages in the pipeline, and can be configured to issue notifications as the pipeline executes.<br><br>Automatic triggers can be a Jenkins job, a CRON schedule, or another pipeline. You can also manually start a pipeline. Notifications can be sent out to email, SMS or HipChat on pipeline start/complete/fail.\n\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/Y1X8CO7KTkO7vO9x3ZZi_pipeline.png\",\n        \"pipeline.png\",\n        \"486\",\n        \"271\",\n        \"#4585c5\",\n        \"\"\n      ],\n      \"sizing\": \"smart\"\n    }\n  ]\n}\n[/block]\n* **Stage**: A *Stage* in Spinnaker is an atomic building block for a pipeline. Stages in a Pipeline can be sequenced in any order, though some stage sequences may be more common than others. Spinnaker comes pre-packaged with a number of stages, including:\n  * **Bake**: Bakes an image in the specified region.\n  * **Deploy**: Deploys a previously baked or found image.\n  * **Destroy Server Group**: Destroys a server group.\n  * **Disable Server Group**: Disables a server group.\n  * **Enable Server Group**: Enables a server group.\n  * **Find Image**: Finds a previously-baked image to deploy into an existing cluster.\n  * **Jenkins**: Runs a Jenkins job.\n  * **Manual Judgment**: Waits for user approval before continuing.\n  * **Modify Scaling Process**: Suspend or resume server group scaling processes.\n  * **Pipeline**: Runs a pipeline. This allows pipelines to be composed hierarchically.\n  * **Quick Patch Server Group**: Quick patches a server group. Used for emergency patches.\n  * **Resize Server Group**: Resizes a server group.\n  * **Script**: Runs an arbitrary shell script.\n  * **Shrink Cluster**: Shrinks a cluster.\n  * **Wait**: Waits a specified period of time.","excerpt":"","slug":"overview","type":"basic","title":"Overview"}
Spinnaker is an open source, multi-cloud continuous delivery platform for releasing software changes with high velocity and confidence. It provides two core sets of features: *cluster management* and *deployment management*. Below we give a top-level overview of these features. ## Cluster Management Spinnaker's cluster management features are used to manage resources in the cloud. * **Server Group**: The base resource to be managed is the *Server Group*. A Server Group identifies the machine instance profile on which to execute images along with the number of instances, and is associated with a Load Balancer and a Security Group. A Server Group is also identified with basic configuration settings, such as user account information and the region/zone in which images are deployed. When deployed, a Server Group is a collection of virtual machines running software. [block:image] { "images": [ { "image": [ "https://files.readme.io/4l9kTko1SVSIcI26iBSR_server_group.png", "server_group.png", "506", "316", "#c92933", "" ] } ] } [/block] * **Security Group**: A *Security Group* defines network traffic access. It is effectively a set of firewall rules defined by an IP range (CIDR) along with a communication protocol (e.g., TCP) and port range. * **Load Balancer**: A *Load Balancer* is associated with an ingress protocol and port range, and balances traffic among instances in the corresponding Server Group. Optionally, you can enable health checks for a load balancer, with flexiblity to define health criteria and specify the health check endpoint. * **Cluster**: A *Cluster* is a user-defined, logical grouping of Server Groups in Spinnaker. ## Deployment Management Spinnaker's deployment management features are used to construct and manage continuous delivery workflows. * **Pipeline**: *Pipelines* are the key deployment management construct in Spinnaker. They are defined by a sequence of stages, along with automated triggers (optional) that kick off the pipeline, parameters that get passed to all stages in the pipeline, and can be configured to issue notifications as the pipeline executes.<br><br>Automatic triggers can be a Jenkins job, a CRON schedule, or another pipeline. You can also manually start a pipeline. Notifications can be sent out to email, SMS or HipChat on pipeline start/complete/fail. [block:image] { "images": [ { "image": [ "https://files.readme.io/Y1X8CO7KTkO7vO9x3ZZi_pipeline.png", "pipeline.png", "486", "271", "#4585c5", "" ], "sizing": "smart" } ] } [/block] * **Stage**: A *Stage* in Spinnaker is an atomic building block for a pipeline. Stages in a Pipeline can be sequenced in any order, though some stage sequences may be more common than others. Spinnaker comes pre-packaged with a number of stages, including: * **Bake**: Bakes an image in the specified region. * **Deploy**: Deploys a previously baked or found image. * **Destroy Server Group**: Destroys a server group. * **Disable Server Group**: Disables a server group. * **Enable Server Group**: Enables a server group. * **Find Image**: Finds a previously-baked image to deploy into an existing cluster. * **Jenkins**: Runs a Jenkins job. * **Manual Judgment**: Waits for user approval before continuing. * **Modify Scaling Process**: Suspend or resume server group scaling processes. * **Pipeline**: Runs a pipeline. This allows pipelines to be composed hierarchically. * **Quick Patch Server Group**: Quick patches a server group. Used for emergency patches. * **Resize Server Group**: Resizes a server group. * **Script**: Runs an arbitrary shell script. * **Shrink Cluster**: Shrinks a cluster. * **Wait**: Waits a specified period of time.