Skip to content

Commit

Permalink
Docs generation for caas (#40)
Browse files Browse the repository at this point in the history
* Docs generation for caas

* New caas release with docs changes
  • Loading branch information
J0HNB0Y authored Jun 16, 2022
1 parent 5885db6 commit 24365c3
Show file tree
Hide file tree
Showing 17 changed files with 812 additions and 44 deletions.
2 changes: 1 addition & 1 deletion GNUmakefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#(C) Copyright 2021-2022 Hewlett Packard Enterprise Development LP
GOFMT_FILES?=$$(find . -name '*.go' | grep -v vendor)
DEPEND_REPO=HewlettPackard/hpegl-vmaas-terraform-resources hewlettpackard/hpegl-metal-terraform-resources
DEPEND_REPO=HewlettPackard/hpegl-vmaas-terraform-resources hewlettpackard/hpegl-metal-terraform-resources HewlettPackard/hpegl-containers-terraform-resources

prefix=hpegl-
suffix=-terraform-resources
Expand Down
113 changes: 113 additions & 0 deletions docs/data-sources/caas_cluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
---
page_title: "hpegl_caas_cluster Data Source - terraform-provider-hpegl"
subcategory: "caas"
description: |-
Cluster data source allows reading cluster data
based on name and space ID. Required inputs are name and space_id
---
# hpegl_caas_cluster (Data Source)

Cluster data source allows reading cluster data
based on name and space ID. Required inputs are name and space_id



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String)
- `space_id` (String)

### Read-Only

- `api_endpoint` (String)
- `appliance_name` (String)
- `blueprint_id` (String)
- `cluster_provider` (String)
- `created_date` (String)
- `default_storage_class` (String)
- `default_storage_class_description` (String)
- `health` (String)
- `id` (String) The ID of this resource.
- `k8s_version` (String)
- `kubeconfig` (String)
- `last_update_date` (String)
- `machine_sets` (List of Object) (see [below for nested schema](#nestedatt--machine_sets))
- `machine_sets_detail` (List of Object) (see [below for nested schema](#nestedatt--machine_sets_detail))
- `service_endpoints` (List of Object) (see [below for nested schema](#nestedatt--service_endpoints))
- `site_id` (String)
- `state` (String)

<a id="nestedatt--machine_sets"></a>
### Nested Schema for `machine_sets`

Read-Only:

- `count` (Number)
- `machine_blueprint_id` (String)
- `name` (String)
- `os_image` (String)
- `os_version` (String)


<a id="nestedatt--machine_sets_detail"></a>
### Nested Schema for `machine_sets_detail`

Read-Only:

- `compute_type` (String)
- `count` (Number)
- `machine_blueprint_id` (String)
- `machine_provider` (String)
- `machine_roles` (List of String)
- `machines` (List of Object) (see [below for nested schema](#nestedobjatt--machine_sets_detail--machines))
- `name` (String)
- `networks` (List of String)
- `os_image` (String)
- `os_version` (String)
- `proxy` (String)
- `size` (String)
- `size_detail` (List of Object) (see [below for nested schema](#nestedobjatt--machine_sets_detail--size_detail))
- `storage_type` (String)

<a id="nestedobjatt--machine_sets_detail--machines"></a>
### Nested Schema for `machine_sets_detail.machines`

Read-Only:

- `created_date` (String)
- `health` (String)
- `hostname` (String)
- `id` (String)
- `last_update_date` (String)
- `name` (String)
- `state` (String)


<a id="nestedobjatt--machine_sets_detail--size_detail"></a>
### Nested Schema for `machine_sets_detail.size_detail`

Read-Only:

- `cpu` (Number)
- `ephemeral_disk` (Number)
- `memory` (Number)
- `name` (String)
- `persistent_disk` (Number)
- `root_disk` (Number)



<a id="nestedatt--service_endpoints"></a>
### Nested Schema for `service_endpoints`

Read-Only:

- `endpoint` (String)
- `name` (String)
- `namespace` (String)
- `type` (String)


44 changes: 44 additions & 0 deletions docs/data-sources/caas_cluster_blueprint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
page_title: "hpegl_caas_cluster_blueprint Data Source - terraform-provider-hpegl"
subcategory: "caas"
description: |-
Cluster Blueprint data source allows reading cluster blueprint data
based on blueprint name and space ID. Required inputs are name and space_id
---
# hpegl_caas_cluster_blueprint (Data Source)

Cluster Blueprint data source allows reading cluster blueprint data
based on blueprint name and space ID. Required inputs are name and space_id



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String)
- `site_id` (String)

### Read-Only

- `cluster_provider` (String)
- `created_date` (String)
- `default_storage_class` (String)
- `id` (String) The ID of this resource.
- `k8s_version` (String)
- `last_update_date` (String)
- `machine_sets` (List of Object) (see [below for nested schema](#nestedatt--machine_sets))

<a id="nestedatt--machine_sets"></a>
### Nested Schema for `machine_sets`

Read-Only:

- `count` (Number)
- `machine_blueprint_id` (String)
- `name` (String)
- `os_image` (String)
- `os_version` (String)


97 changes: 97 additions & 0 deletions docs/data-sources/caas_cluster_provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
page_title: "hpegl_caas_cluster_provider Data Source - terraform-provider-hpegl"
subcategory: "caas"
description: |-
ClusterProvider data source allows reading Cluster Provider data
based on name and site ID. Required inputs are name and site ID
---
# hpegl_caas_cluster_provider (Data Source)

ClusterProvider data source allows reading Cluster Provider data
based on name and site ID. Required inputs are name and site ID



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String)
- `site_id` (String)

### Read-Only

- `available_capacity` (List of Object) (see [below for nested schema](#nestedatt--available_capacity))
- `created_date` (String)
- `health` (String)
- `id` (String) The ID of this resource.
- `k8s_versions` (List of String)
- `last_update_date` (String)
- `license_info` (List of Object) (see [below for nested schema](#nestedatt--license_info))
- `min_master_size` (List of Object) (see [below for nested schema](#nestedatt--min_master_size))
- `min_worker_size` (List of Object) (see [below for nested schema](#nestedatt--min_worker_size))
- `state` (String)
- `storage_classes` (List of Object) (see [below for nested schema](#nestedatt--storage_classes))

<a id="nestedatt--available_capacity"></a>
### Nested Schema for `available_capacity`

Read-Only:

- `clusters` (Number)
- `cpu` (Number)
- `nodes` (Number)


<a id="nestedatt--license_info"></a>
### Nested Schema for `license_info`

Read-Only:

- `label` (String)
- `status` (String)
- `summary` (String)


<a id="nestedatt--min_master_size"></a>
### Nested Schema for `min_master_size`

Read-Only:

- `cpu` (Number)
- `ephemeral_disk` (Number)
- `memory` (Number)
- `name` (String)
- `persistent_disk` (Number)
- `root_disk` (Number)


<a id="nestedatt--min_worker_size"></a>
### Nested Schema for `min_worker_size`

Read-Only:

- `cpu` (Number)
- `ephemeral_disk` (Number)
- `memory` (Number)
- `name` (String)
- `persistent_disk` (Number)
- `root_disk` (Number)


<a id="nestedatt--storage_classes"></a>
### Nested Schema for `storage_classes`

Read-Only:

- `access_protocol` (String)
- `cost_per_gb` (String)
- `dedupe` (String)
- `description` (String)
- `encryption` (String)
- `gl_storage_type` (String)
- `iops` (String)
- `name` (String)


49 changes: 49 additions & 0 deletions docs/data-sources/caas_machine_blueprint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
page_title: "hpegl_caas_machine_blueprint Data Source - terraform-provider-hpegl"
subcategory: "caas"
description: |-
Machine Blueprint data source allows reading machine blueprint data
based on blueprint name and appliance ID. Required inputs are name and site_id
---
# hpegl_caas_machine_blueprint (Data Source)

Machine Blueprint data source allows reading machine blueprint data
based on blueprint name and appliance ID. Required inputs are name and site_id



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String)
- `site_id` (String)

### Read-Only

- `compute_type` (String)
- `created_date` (String)
- `id` (String) The ID of this resource.
- `last_update_date` (String)
- `machine_provider` (String)
- `machine_roles` (List of String)
- `os_image` (String)
- `os_version` (String)
- `size` (String)
- `size_detail` (List of Object) (see [below for nested schema](#nestedatt--size_detail))
- `storage_type` (String)

<a id="nestedatt--size_detail"></a>
### Nested Schema for `size_detail`

Read-Only:

- `cpu` (Number)
- `ephemeral_disk` (Number)
- `memory` (Number)
- `name` (String)
- `persistent_disk` (Number)
- `root_disk` (Number)


29 changes: 29 additions & 0 deletions docs/data-sources/caas_site.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
page_title: "hpegl_caas_site Data Source - terraform-provider-hpegl"
subcategory: "caas"
description: |-
Appliance data source allows reading appliance data
based on name and space ID. Required inputs are name and space_id
---
# hpegl_caas_site (Data Source)

Appliance data source allows reading appliance data
based on name and space ID. Required inputs are name and space_id



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String)
- `space_id` (String)

### Read-Only

- `created_date` (String)
- `id` (String) The ID of this resource.
- `last_update_date` (String)


9 changes: 9 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ provider "hpegl" {

- `api_vended_service_client` (Boolean) Declare if the API client being used is an API-vended one or not. Defaults to "true"
i.e. the client is API-vended. The value can be set using the HPEGL_API_VENDED_SERVICE_CLIENT env-var.
- `caas` (Block Set, Max: 1) (see [below for nested schema](#nestedblock--caas))
- `iam_service_url` (String) The IAM service URL to be used to generate tokens. In the case of API-vended API clients
(the default) then this should be set to the "issuer url" for the client. In the case of non-API-vended
API clients use the appropriate GL "client" URL. Can be set by HPEGL_IAM_SERVICE_URL env-var
Expand All @@ -67,6 +68,14 @@ provider "hpegl" {
- `user_secret` (String) The user secret to be used, can be set by HPEGL_USER_SECRET env-var
- `vmaas` (Block Set, Max: 1) (see [below for nested schema](#nestedblock--vmaas))

<a id="nestedblock--caas"></a>
### Nested Schema for `caas`

Optional:

- `api_url` (String) The URL to use for the CaaS API, can also be set with the HPEGL_CAAS_API_URL env var


<a id="nestedblock--metal"></a>
### Nested Schema for `metal`

Expand Down
Loading

0 comments on commit 24365c3

Please sign in to comment.