Skip to content

Easily automate Delphix Self Service actions in CI/CD Pipelines without being tied to any specific CI Software.

License

Notifications You must be signed in to change notification settings

delphix/automation-framework

Repository files navigation

Delphix Automation Framework

The Delphix Automation Framework (DAF) allows automating data management via APIs at scale. Easily automate Delphix Self Service actions in CI/CD Pipelines without being tied to any specific CI Software.

Table of Contents

  1. Description
  2. Installation
  3. Usage
  4. Links
  5. Contribute
  6. Reporting Issues
  7. Statement of Support
  8. License

Description

DAF combines environment variables commonly available during CI/CD and data management as code in the delphix.yaml file to automate API calls to the Delphix Dynamic Data Platform. This allows for chain-able API calls that can be triggered during different stages of the CI/CD pipeline. The data state for different non-production environments is now visible through code configuration and that configuration is under version control.

Installation

The tools and executable for DAF have been containerized with docker for convenience. Use the latest version by pulling the container below.

docker pull delphix/automation-framework

The delphix.yaml file

The delphix.yaml file is the configuration file that defines the data management as code strategy for the project. Create a delphix.yaml file based on this guide: Configure Delphix YAML

Usage

Create an .env file with the following values:

  • GIT_BRANCH=
  • DELPHIX_PASS=
  • DELPHIX_USER=
  • DELPHIX_ENGINE=
  • GIT_EVENT=
  • GIT_COMMIT=

Optionally, the GIT_EVENT can be set by a GitHub Webhook Payload file: payload.json.

Run the docker container with your project mounted as a volume and environment file instantiated.

docker run -v ${PWD}:/daf/app --env-file ${PWD}/.env delphix/automation-framework

Links

Contribute

  1. Fork the project.
  2. Make your bug fix or new feature.
  3. Add tests for your code.
  4. Send a pull request.

Contributions must be signed as User Name <[email protected]>. Make sure to set up Git with user name and email address. Bug fixes should branch from the current stable branch. New features should be based on the master branch.

Code of Conduct

This project operates under the Delphix Code of Conduct. By participating in this project you agree to abide by its terms.

Contributor Agreement

All contributors are required to sign the Delphix Contributor agreement prior to contributing code to an open source repository. This process is handled automatically by cla-assistant. Simply open a pull request and a bot will automatically check to see if you have signed the latest agreement. If not, you will be prompted to do so as part of the pull request process.

Reporting Issues

Issues should be reported in the GitHub repo's issue tab. Include a link to it.

Statement of Support

This software is provided as-is, without warranty of any kind or commercial support through Delphix. See the associated license for additional details. Questions, issues, feature requests, and contributions should be directed to the community as outlined in the Delphix Community Guidelines.

License

This is code is licensed under the Apache License 2.0. Full license is available here.

About

Easily automate Delphix Self Service actions in CI/CD Pipelines without being tied to any specific CI Software.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published