xl-blueprints-community

XebiaLabs Blueprints

Blueprint definitions for xl-cli. These files will be synced to https://xebialabs-community.github.io/xl-blueprints-community/ and can be used as xl-cli blueprint repository (using xl blueprint --blueprint-repository-url https://xebialabs-community.github.io/xl-blueprints-community/).

Blueprint Development

To develop new blueprints, fork the blueprints repository then do the following…

  1. Run a web server container to serve content from your local blueprints directory. The easiest approach is to use the included docker-compose.yml file to start an Apache web server as follows: 
     docker-compose up
  2. Edit config.yaml to point to your local XL Release and XL Deploy instances and the above http server
  3. Create a directory for your new blueprint, e.g. conjur
  4. Create a xebialabs directory for templates in your blueprint directory, e.g. conjur/xebialabs
    • Note: The directory must be called xebialabs or the secrets handling will not work
  5. Add blueprint.yaml to your blueprint directory
  6. Add one or more templates to the templates directory
  7. Edit the index.json to include your blueprint directory
  8. Test your blueprint by running with the local files, output yaml will be found in the blueprint xebialabs directory: 
     xl --config config.yaml blueprint
  9. Apply your generated .yaml(s) to XL tools: 
     xl --config ./config.yaml apply -f ./xebialabs/<your template>.yaml
  10. Once development is complete, commit and push the changes

Docker

To host your blueprints locally, you can use the Dockerfile to run an Apache server:

  1. Build and run: docker build -t blueprints . && docker run -p 8080:80 -it blueprints
  2. Use a blueprint xl blueprint --blueprint-repository-url http://localhost:8080

Publish

Any changes that are dependent on a new XL CLI version should be done only on the development branch. Master branch should only contain published changes. Development branch needs to be synced to master during every official XL-CLI release

The official blueprints are hosted on our distribution site and are published using the internal Jenkins Job which is triggered manually.

Run publish.py script to update the S3 bucket for development availabvle at https://s3.amazonaws.com/xl-cli/blueprints

Prerequisites

Blue Blueprints