Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/j0hn-b/terraform-port-blueprint
Create Port blueprints using their json definition files
https://github.com/j0hn-b/terraform-port-blueprint
Last synced: 5 days ago
JSON representation
Create Port blueprints using their json definition files
- Host: GitHub
- URL: https://github.com/j0hn-b/terraform-port-blueprint
- Owner: J0hn-B
- License: mit
- Created: 2024-02-20T15:21:59.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-04-18T09:23:43.000Z (7 months ago)
- Last Synced: 2024-04-18T11:21:21.609Z (7 months ago)
- Language: HCL
- Size: 31.3 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Port Blueprint Module
This Terraform module creates [blueprints](https://registry.terraform.io/providers/port-labs/port-labs/latest/docs/resources/port_blueprint) in [Port](https://app.getport.io/) using the blueprint json schema.
1. Create the [blueprint](https://docs.getport.io/build-your-software-catalog/define-your-data-model/setup-blueprint/) in Port and copy the json definition
2. Save the json definition in a local directory or in a git repository
3. Use the module to create the blueprint in Port
## How it works
The module will create the blueprints defined in the blueprint json schema following the order below:
- First run of `terraform apply` will create the blueprints defined in the blueprint json files
- Second run of `terraform apply` will `add || update` the blueprints relations (if any)
- Third run of `terraform apply` will `add || update` the blueprints mirrorProperties (if any)
---
[](https://github.com/J0hn-B/terraform-port-blueprint/actions/workflows/static_analysis_scan.yml) :anchor: [](https://github.com/J0hn-B/terraform-port-blueprint/actions/workflows/tests.yml)
[](https://github.com/J0hn-B/terraform-port-blueprint/actions/workflows/validation.yml) :ship:
Terraform Providers and Plan Validation: each workflow run includes details about Terraform Providers.
##
## Examples
[Basic Example Dir](/examples/basic_example/)
```bash
# Export your Port Credentials
export TF_VAR_client_id="your_client_id"
export TF_VAR_client_secret="your_client_secret"
```
---
```bash
# Create a local directory in your root folder
mkdir blueprint_json_files && cd blueprint_json_files
# Download a blueprint JSON file and save it
curl -0 https://raw.githubusercontent.com/port-labs/template-assets/main/kubernetes/blueprints/argo-blueprints.json > argo-blueprints.json
# Create a main.tf
cd ..
touch main.tf
```
```dir
# $ tree
.
|-- blueprint_json_files
| `-- argo-blueprints.json
`-- main.tf
```
---
> [!NOTE]
> To access this module outside of the Terraform registry, replace:
```diff
# Module source
- source = "J0hn-B/blueprint/port"
- version = ">= 0.1
+ source = "github.com/J0hn-B/terraform-port-blueprint?ref=v0.1.1
```
```hcl
// main.tf (basic example)
# Provider
terraform {
required_providers {
port = {
source = "port-labs/port-labs"
version = ">= 1.10.1"
}
}
}
provider "port" {
client_id = var.client_id
secret = var.client_secret
}
# Variables
variable "client_id" { type = string }
variable "client_secret" { type = string }
module "port" {
# Module source
source = "J0hn-B/blueprint/port"
version = ">= 0.1"
# Port API credentials
client_id = var.client_id
client_secret = var.client_secret
# Path to the directory containing the blueprint json files (required)
blueprint_dir = "${path.module}/blueprint_json_files"
}
# Output
// Return the blueprint definition
output "blueprint" {
value = module.port.blueprint
}
```
Advanced
[Advanced Example Dir](/examples/advanced_example/)
- Complete the basic example
- Replace the `main.tf` file with the following code:
```hcl
// main.tf
# Provider
terraform {
required_providers {
port = {
source = "port-labs/port-labs"
version = ">= 1.10.1"
}
github = {
source = "integrations/github"
version = ">= 5.45.0"
}
}
}
provider "port" {
client_id = var.client_id
secret = var.client_secret
}
# Variables
variable "client_id" { type = string }
variable "client_secret" { type = string }
# Get the json configuration from the gitops repository
data "github_repository" "port_labs" {
full_name = "port-labs/template-assets"
}
data "github_repository_file" "lean_kubernetes_usecase_bps" {
repository = data.github_repository.port_labs.full_name
branch = "main"
file = "kubernetes/blueprints/lean_kubernetes_usecase_bps.json"
}
# Module
module "port" {
// Set the module source
source = "J0hn-B/blueprint/port"
version = ">= 0.1"
// Port API credentials used by hashicorp/http provider
client_id = var.client_id
client_secret = var.client_secret
// Set the path to the directory containing the blueprint json files
blueprint_dir = "${path.module}/blueprint_json_files"
// Get the blueprints json data
blueprint_repo = data.github_repository_file.lean_kubernetes_usecase_bps.content
// Force delete entities (optional)
force_delete_entities = true
}
```
##
---
### Outputs
The module has a single output named `blueprint` which returns the blueprint definition.
Access the output values using the syntax as shown in the example below:
```hcl
output "blueprint" {
value = module.port.blueprint
// Access output values (examples)
// module.port.blueprint["workload"]["properties"]["array_props"]["containers"]["description"]
}
```