From dd5e6c276cd2695539f21ea6467d976d5b3700c7 Mon Sep 17 00:00:00 2001 From: Alex Hung Date: Mon, 15 Jul 2024 13:40:23 -0700 Subject: [PATCH] Add doc for jpd resource --- docs/resources/jpd.md | 91 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 docs/resources/jpd.md diff --git a/docs/resources/jpd.md b/docs/resources/jpd.md new file mode 100644 index 0000000..40a2024 --- /dev/null +++ b/docs/resources/jpd.md @@ -0,0 +1,91 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "missioncontrol_jpd Resource - missioncontrol" +subcategory: "" +description: |- + Provides a JFrog Platform Deployment https://jfrog.com/help/r/jfrog-platform-administration-documentation/manage-platform-deployments resource to manage JPD. + ~>Supported on the Self-Hosted platform, with an Enterprise X or Enterprise+ license. +--- + +# missioncontrol_jpd (Resource) + +Provides a [JFrog Platform Deployment](https://jfrog.com/help/r/jfrog-platform-administration-documentation/manage-platform-deployments) resource to manage JPD. +~>Supported on the Self-Hosted platform, with an Enterprise X or Enterprise+ license. + + + + +## Schema + +### Required + +- `location` (Attributes) The geographical location of the Platform Deployment to be displayed on a global Platform Deployment view (see [below for nested schema](#nestedatt--location)) +- `name` (String) A unique logical name for this Platform Deployment +- `url` (String) The Platform deployment URL: http://:/; for example: http://myplatformserver:8082/. Note: For legacy instances, version 6.x and lower, the URL should contain the instance root context: http://://; for example http://myv6server:8081/artifactory/. URL must ends with trailing slash. + +### Optional + +- `password` (String, Sensitive) Admin password for legacy JPD (Artifactory 6.x). +- `tags` (Set of String) Add labels to be applied for filtering Platform Deployments according to categories for example, location, dedicated centers - dev, testing, production +- `token` (String, Sensitive) JPD join key +- `username` (String) Admin username for legacy JPD (Artifactory 6.x). + +### Read-Only + +- `base_url` (String) +- `cold_storage_jpd` (String) +- `id` (String) The ID of this resource. +- `is_cold_storage` (Boolean) +- `licenses` (Attributes Set) (see [below for nested schema](#nestedatt--licenses)) +- `local` (Boolean) +- `services` (Attributes Set) (see [below for nested schema](#nestedatt--services)) +- `status` (Attributes) (see [below for nested schema](#nestedatt--status)) + + +### Nested Schema for `location` + +Required: + +- `city_name` (String) +- `country_code` (String) 2 letters ISO-3166-2 country code +- `latitude` (Number) +- `longitude` (Number) + + + +### Nested Schema for `licenses` + +Read-Only: + +- `expired` (Boolean) +- `license_hash` (String) +- `licensed_to` (String) +- `type` (String) +- `valid_through` (String) + + + +### Nested Schema for `services` + +Read-Only: + +- `status` (Attributes) (see [below for nested schema](#nestedatt--services--status)) +- `type` (String) + + +### Nested Schema for `services.status` + +Read-Only: + +- `code` (String) + + + + +### Nested Schema for `status` + +Read-Only: + +- `code` (String) +- `message` (String) +- `warnings` (Set of String)