Skip to content

Commit 7e28b10

Browse files
ankit-patil-hubsankit-patil-hubs
authored
Merge branch 'develop' into source_changes
2 parents 4867a30 + 4e9d909 commit 7e28b10

File tree

2 files changed

+90
-43
lines changed

2 files changed

+90
-43
lines changed

‎.github/workflows/codeql.yml‎

Lines changed: 52 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,39 @@
1-
# CodeQL configuration for the dxi-terraform-provider repo
1+
#
2+
# Copyright (c) 2023, 2024 by Delphix. All rights reserved.
3+
#
4+
#
5+
# For most projects, this workflow file will not need changing; you simply need
6+
# to commit it to your repository.
7+
#
8+
# You may wish to alter this file to override the set of languages analyzed,
9+
# or to provide custom queries or build logic.
10+
#
11+
# ******** NOTE ********
12+
# We have attempted to detect the languages in your repository. Please check
13+
# the `language` matrix defined below to confirm you have the correct set of
14+
# supported CodeQL languages.
15+
#
216
name: "CodeQL"
317

418
on:
519
push:
620
branches: [ main, develop ]
721
pull_request:
8-
branches: [ develop ]
22+
# The branches below must be a subset of the branches above
23+
branches: [ "develop" ]
24+
schedule:
25+
- cron: '40 13 * * 5'
926

1027
jobs:
1128
analyze:
1229
name: Analyze
13-
runs-on: ubuntu-latest
30+
# Runner size impacts CodeQL analysis time. To learn more, please see:
31+
# - https://gh.io/recommended-hardware-resources-for-running-codeql
32+
# - https://gh.io/supported-runners-and-hardware-resources
33+
# - https://gh.io/using-larger-runners
34+
# Consider using larger runners for possible analysis time improvements.
35+
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
36+
timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
1437
permissions:
1538
actions: read
1639
contents: read
@@ -20,38 +43,45 @@ jobs:
2043
fail-fast: false
2144
matrix:
2245
language: [ 'go' ]
46+
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby', 'swift' ]
47+
# Use only 'java' to analyze code written in Java, Kotlin or both
48+
# Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
49+
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
2350

2451
steps:
2552
- name: Checkout repository
26-
uses: actions/checkout@v2
27-
28-
- uses: actions/setup-go@v2
29-
with:
30-
go-version: '^1.17.7'
53+
uses: actions/checkout@v3
3154

3255
# Initializes the CodeQL tools for scanning.
3356
- name: Initialize CodeQL
34-
uses: github/codeql-action/init@v1
57+
uses: github/codeql-action/init@v2
3558
with:
3659
languages: ${{ matrix.language }}
37-
queries: +security-and-quality
60+
queries: security-extended,security-and-quality
61+
# If you wish to specify custom queries, you can do so here or in a config file.
62+
# By default, queries listed here will override any specified in a config file.
63+
# Prefix the list here with "+" to use these queries and those in the config file.
3864

65+
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
66+
# queries: security-extended,security-and-quality
3967

40-
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
41-
# If this step fails, then you should remove it and run the build manually (see below)
42-
- name: Autobuild
43-
uses: github/codeql-action/autobuild@v1
4468

69+
# Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
70+
# If this step fails, then you should remove it and run the build manually (see below)
71+
- if: matrix.language == 'go'
72+
name: Autobuild
73+
uses: github/codeql-action/autobuild@v2
4574
# ℹ️ Command-line programs to run using the OS shell.
46-
# 📚
75+
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
4776

48-
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
49-
# and modify them (or add more) to build your code if your project
50-
# uses a compiled language
77+
# If the Autobuild fails above, remove it and uncomment the following three lines.
78+
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
5179

52-
#- run: |
53-
# make bootstrap
54-
# make release
80+
# - run: |
81+
# echo "Run, Build Application using script"
82+
# ./location_of_script_within_repo/buildscript.sh
5583

5684
- name: Perform CodeQL Analysis
57-
uses: github/codeql-action/analyze@v1
85+
uses: github/codeql-action/analyze@v2
86+
with:
87+
category: "/language:${{matrix.language}}"

‎docs/index.md‎

Lines changed: 38 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,53 @@
11
# <provider> Delphix Provider
22

3-
!> **NOTE**
4-
The Terraform Provider for Delphix requires the Delphix Continuous Data Platform and Data Control Tower (DCT).
3+
The Terraform Provider for Delphix enables you to natively manage data-as-code along with your infrastructure.
54

5+
With Terraform and Delphix, you can now automatically provision, manage, and teardown any number of ephemeral data environments to drive enterprise DevOps workflows, such as test data management.
66

7-
The Terraform Provider for Delphix enables customers to natively manage data-as-code along with their infrastructure.
8-
With Terraform and Delphix, customers can now automatically provision, manage and teardown any number of ephemeral data environments to drive enterprise DevOps workflows including test data management.
7+
This provider communicates directly with Data Control Tower (DCT) to generated virtual database and other objects. Therefore, DCT must be registered with one or more Delphix Continuous Data Engines.
98

10-
This provider leverages the Delphix APIs available with the Delphix Data Control Tower (DCT). The provider must be configured with the proper API key generated by DCT and registered with associated Delphix engines before use
9+
To learn more about Delphix and DCT APIs, refer to [Delphix Documentation](https://documentation.delphix.com/docs/) and [DCT Documentation](https://dct.delphix.com/docs/latest/) respectively. Please [Contact us](ask-integrations@delphix.com) (ask-integrations@delphix.com) with any questions.
1110

12-
To learn more about Delphix and DCT APIs, refer to [Delphix Docs](https://docs.delphix.com) and [DCT Docs](https://docs.delphix.com/dct) respectively. Please [Contact us](ask-integrations@delphix.com) (ask-integrations@delphix.com) with any questions.
11+
If you are entitled to Data Control Tower then you may also send support issues through the [Delphix Support Portal](https://support.delphix.com/).
12+
13+
## System Requirements
14+
15+
| Product | Version |
16+
|--------------------------------|----------|
17+
| Data Control Tower (DCT) | v14+ |
18+
| Delphix Continuous Data Engine | v6.0.0.1+ |
19+
20+
Note: The DCT version above guarantees full provider support. However, each resource might support older versions. Refer to the specific resource documentation page for more information.
21+
22+
## Release Notes
23+
24+
The Delphix Provider's complete release notes can be found in the [Delphix Ecosystem Documentation](https://ecosystem.delphix.com/docs/main/release-notes-terraform).
25+
26+
## Connectivity and Authentication
27+
28+
All communication is performed through HTTPS. The Delphix Provider uses Data Control Tower (DCT) APIs to communicate with Delphix Continuous Data Engines.
29+
30+
Authentication with DCT APIs are managed using API Keys. For generation of an API key, please refer to [DCT API Keys](https://dct.delphix.com/docs/latest/api-keys).
1331

1432
## Example Usage
1533

34+
The following script demonstrates how to configure the Delphix Provider to connect with Data Control Tower and then provision a VDB. Additional resource guides and documentation can be found on the left hand side.
35+
1636
```hcl
1737
terraform {
1838
required_providers {
1939
delphix = {
2040
source = "delphix-integrations/delphix"
21-
version = "1.0.0"
41+
version = "3.2.0"
2242
}
2343
}
2444
}
2545
2646
# Configure the DXI Provider
2747
provider "delphix" {
28-
tls_insecure_skip = true
29-
key = "dct_api_key"
3048
host = "dct_hostname"
49+
key = "dct_api_key"
50+
tls_insecure_skip = false
3151
}
3252
3353
# Provision a VDB
@@ -37,18 +57,14 @@ resource "delphix_vdb" "vdb_name" {
3757
}
3858
```
3959

40-
## Configuration and API Key Generation
41-
42-
Delphix Provider uses DCT APIs to communicate with the Delphix engines. Authentication to DCT APIs are handled using API Keys.
43-
For generation of the API key, please refer to [Authentication](https://docs.delphix.com/dct/authentication-170164311.html).
60+
### Example Global Parameter Reference
4461

45-
46-
## Argument Reference
47-
48-
* __key__ : The API key is provided in this field that gets passed on to DCT for authentication.
49-
* __host__: The host name for where DCT APIGW is running.
50-
* __tls_insecure_skip__: This takes a boolean value which determines whether to skip the TLS check. tls_insecure_skip is really unsafe to set it to true. By default it is `false`.
51-
* __host_scheme__: Determines the host scheme configured. By default it is `https`.
62+
* __host__: The hostname for DCT.
63+
* __key__ : The API Key which is used to authenticate with DCT. (Example `apk 2.abc123...`).
64+
* __tls_insecure_skip__: (Optional) A boolean value which determines whether to skip the SSL/TLS check. The default value is `false`. Skipping any SSL/TLS check is not recommended for production environments.
65+
* __host_scheme__: (Optional) Determines the configured host URL's scheme. The default value is `https`.
66+
67+
Consult the documentation's Resources section for details on individual resources, such as VDB, dSource, and Environment.
5268

5369
## Support Matrix
5470

@@ -59,4 +75,5 @@ delphix_vdb_group | v 1.0.0 | v 2.0.0
5975
delphix_environment | v 1.0.0 | v 2.0.0
6076
delphix_appdata_dsource | v 2.1.0 | v 10.0.0
6177
delphix_oracle_dsource | v 3.1.0 | v 10.0.0
62-
delphix_database_postgresql | v 3.2.0 | v 14.0.0
78+
delphix_database_postgresql | v 3.2.0 | v 14.0.0
79+

0 commit comments

Comments
 (0)