https://github.com/circleci-public/spinnaker-orb
A CircleCI Orb to simplify deployments via Spinnaker.
https://github.com/circleci-public/spinnaker-orb
circleci-orbs spinnaker
Last synced: 7 months ago
JSON representation
A CircleCI Orb to simplify deployments via Spinnaker.
- Host: GitHub
- URL: https://github.com/circleci-public/spinnaker-orb
- Owner: CircleCI-Public
- License: mit
- Created: 2019-08-07T10:49:52.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-25T14:04:40.000Z (over 1 year ago)
- Last Synced: 2025-01-16T05:26:03.132Z (9 months ago)
- Topics: circleci-orbs, spinnaker
- Homepage: http://circleci.com/orbs/registry/orb/circleci/spinnaker
- Size: 74.2 KB
- Stars: 3
- Watchers: 12
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spinnaker Orb
This orb is no longer supported by CircleCI because of limited or no use. If you would like to use this orb or create your own version feel free to fork the repository and use the following https://circleci.com/blog/building-private-orbs/ as a guide to making this orb into a private orb for your own use.
[](https://circleci.com/gh/CircleCI-Public/spinnaker-orb) [](https://circleci.com/orbs/registry/orb/circleci/spinnaker) [](https://raw.githubusercontent.com/circleci-public/spinnaker-orb/master/LICENSE) [](https://discuss.circleci.com/c/ecosystem/orbs)
A CircleCI Orb to simplify deployments to Spinnaker.
Here are some features that the Spinnaker orb provides:
- Triggering a Spinnaker application pipeline with a webhook via the `trigger-pipeline-with-webhook` command.
- Installing the spin CLI for managing Spinnaker applications via the `install-spin` command, with a convenience option that generates a simple configuration for a locally-available Spinnaker Gate.
- `set-up-port-forwarding` enables setting up port forwarding for Spinnaker Deck and Spinnaker Gate to interact with Spinnaker through a `localhost` URL.
## Usage
See the [orb registry listing](https://circleci.com/orbs/registry/orb/circleci/spinnaker) for usage guidelines.
## Requirements
- `curl` should be present in `PATH`.
- Some of the commands require a Linux environment to execute in. Refer to the [orb registry listing](https://circleci.com/orbs/registry/orb/circleci/spinnaker) for the descriptions of each command.
- `SPINNAKER_WEBHOOK` environment variable should be set in CircleCI project settings
## Examples
Full usage examples can be found on the Spinnaker orb's page in the orb registry, [here](https://circleci.com/orbs/registry/orb/circleci/spinnaker#usage-examples).
```
version: 2.1
orbs:
# In this example, Spinnaker is assumed to already be
# deployed on an AWS EKS k8s cluster.
aws-eks: circleci/aws-eks@0.2.0
# Replace "x.y.z" with actual orb version
spinnaker: circleci/spinnaker@x.y.z
jobs:
send-webhook:
parameters:
cluster-name:
description: |
Name of the EKS cluster
type: string
aws-region:
description: |
AWS region that the EKS cluster is in
type: string
executor: spinnaker/default-stretch
steps:
# Set up k8s cluster connection.
# In this example, Spinnaker is deployed on an AWS EKS k8s cluster.
- aws-eks/update-kubeconfig-with-authenticator:
cluster-name: << parameters.cluster-name >>
install-kubectl: true
aws-region: << parameters.aws-region >>
# Set wait to true to ensure the webhook endpoint will be
# ready for access via localhost in the next step
- spinnaker/set-up-port-forwarding:
namespace: spinnaker
wait: true
# Send a request to a webhook endpoint pre-configured in Spinnaker
# Ref: https://www.spinnaker.io/guides/user/pipeline/triggers/webhooks/
- spinnaker/trigger-pipeline-with-webhook:
# Example env var value: "http://localhost:8084/webhooks/webhook/myappwebhook"
webhook-endpoint: SPINNAKER_WEBHOOK
payload: "{\\\"status\\\": \\\"success\\\", \\\"jobid\\\": \\\"$CIRCLE_WORKFLOW_JOB_ID\\\", \\\"message\\\": \\\"I've got it\\\"}"
workflows:
example-workflow:
jobs:
- send-webhook:
cluster-name: my-eks-tests
aws-region: ap-southeast-2
```
## Contributing
We welcome [issues](https://github.com/CircleCI-Public/spinnaker-orb/issues) to and [pull requests](https://github.com/CircleCI-Public/spinnaker-orb/pulls) against this repository!
For further questions/comments about this or other orbs, visit [CircleCI's orbs discussion forum](https://discuss.circleci.com/c/orbs).