Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correcting release badge #17

Merged
merged 7 commits into from
Apr 6, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 18 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,49 @@
# Terraform Provider Delphix

![CodeQL](https://github.com/delphix-integrations/terraform-provider-delphix/actions/workflows/codeql.yml/badge.svg?branch=main)
![Release](https://github.com/delphix-integrations/terraform-provider-delphix/actions/workflows/release.yml/badge.svg?event=release)
![Version](https://img.shields.io/github/v/release/delphix-integrations/terraform-provider-delphix)

Terraform Provider for Delphix enables Terraform to create and manage Delphix Continuous Data &
Continuous Compliance infrastructure using the Delphix Control Tower (DCT) APIs.

Full documentation can he found [here](https://integrations.delphix.com/Terraform/)

## Getting Started (Development)
This guide will eventually cover the following
## Prerequisites

1. Setup Delphix Control Tower(DCT) API Layer. For more information, visit [DCT Home.](https://docs.delphix.com/dct)
2. Delphix Engines must be registered with DCT APIs
3. API-Keys must be created for authenticating with DCT APIs. Refer to [DCT Home](https://docs.delphix.com/dct) for more info.
4. Additional infrastructure required for testing the provider operations [ e.g Hosts to be added as environments, dSources to create VDBs from]
5. Development setup for GoLang.


## Getting Started (Development)

1. Setup DCT APi Gateway On Premise by following the [DCT API Gateway setup](https://github.com/delphix/orbital-api-gateway)
This guide covers the following

2. Install IDE [Visual Studio Code](https://code.visualstudio.com)
1. Install IDE [Visual Studio Code](https://code.visualstudio.com)

3. Install guide for [golang](https://go.dev/dl/)
2. Install guide for [golang](https://go.dev/dl/)

4. Install guide for [Goreleaser](https://goreleaser.com/install/)
3. Install guide for [Goreleaser](https://goreleaser.com/install/)

5. Install Go Plugin for VS Code
4. Install Go Plugin for VS Code

6. Install [Terraform](https://www.terraform.io/downloads)
5. Install [Terraform](https://www.terraform.io/downloads)

7. Fork this repo and clone it locally. Switch to develop branch which always heads to the latest development code.
6. Fork this repo and clone it locally. Switch to develop branch which always heads to the latest development code.

8. Run following command to create binaries:
7. Run following command to create binaries:

```goreleaser release --skip-publish --snapshot --rm-dist```

9. Execute example main.tf file under /examples/<resource> directory using the following commands:
8. Execute example main.tf file under /examples/<resource> directory using the following commands:

```
terraform init
terraform plan
terraform apply
```

## Prerequisites

- Delphix Control Tower (DCT) API Gateway must be installed on-premise.
- Delphix Engines must be registered with DCT-OnPrem.
- API-Keys must be created for authenticating with DCT-OnPrem. Refer to DCT guide for more info.
- Additional infrastructure required for testing the provider operations [ e.g Hosts to be added as environments, dSources to create VDBs from]
- Development setup for GoLang.

## Contributing
This project is currently not accepting external contributions.