Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

StackPulse CircleCI Orb

Build License

This CircleCI orb allows you to use your existing CI pipeline to deploy StackPulse playbooks and trigger logic to your production environment. Create code-based playbooks for incident analysis and remediation, then use triggers to automate and orchestrate playbook execution based on events in your environment. This helps you resolve production incidents faster and reduce manual toil.

Configuration

In order to use this orb you will need to have a StackPulse account and to create StackPulse API keys. For those who are already subscribed to StackPulse, the process is explained in detail in the documentation.

After creating the API keys we recommend storing them as Context Environment Variables in your organization or project in order to use this orb.

In the examples below StackPulse API client id and secret are stored as SP_CLIENT_ID and SP_CLIENT_SECRET accordingly in a CircleCI Context.

Jobs

apply

This job will apply playbooks and triggers to your StackPulse account. The job accepts a root directory that contains /playbooks and /triggers sub-directories That will be applied to StackPulse.

PARAMETER DESCRIPTION REQUIRED DEFAULT TYPE
src Root of your repo containing playbooks and triggers folders. - /workspace string

Commands

install

This command install the stackpulse cli tool to your pipeline execution environment.

apply-playbook

This command applies playbooks to your StackPulse account.

PARAMETER DESCRIPTION REQUIRED DEFAULT TYPE
src Source of your playbook files, can be a file or a directory. - string

apply-trigger

This command applies triggers to your StackPulse account.

PARAMETER DESCRIPTION REQUIRED DEFAULT TYPE
src Source of your trigger files, can be a file or a directory. - string

Executors

default

StackPulse CLI Docker executor

PARAMETER DESCRIPTION REQUIRED DEFAULT TYPE
tag Pick a specific stackpulse cli tag - latest string

Examples

Using the apply job to apply a directory of playbooks and triggers

version: 2.1
  orbs:
    stackpulse: stackpulse/stackpulse@1.0
  workflows:
    use-my-orb:
      jobs:
        - stackpulse/apply:
          context: orbs
          src: ./my-dir-containing-playbooks-and-triggers

Troubleshooting

Please feel free to open an issue for any problem you may encounter or improvement conceived while using this orb.

We will update this sections with common issues or FAQs periodically.

Releases

No releases published

Packages

No packages published