Skip to content

Commit

Permalink
Merge pull request #12 from aws-ia/housekeeping
Browse files Browse the repository at this point in the history
  • Loading branch information
tlindsay42 authored Jan 5, 2023
2 parents 0a1de33 + ede8e2c commit e80d041
Show file tree
Hide file tree
Showing 14 changed files with 54 additions and 54 deletions.
26 changes: 13 additions & 13 deletions .header.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# vSphere Content Library Terraform Module

This Terraform module creates or imports a [datastore](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.storage.doc/GUID-7BED10DD-3EF2-4670-BA7F-0EEB4EC6EB85.html)‑backed [content library](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-254B2CE8-20A8-43F0-90E8-3F6776C2C896.html?hWord=N4IghgNiBcIMYHsB2AXApqgBBAlgIwCcwCBPEAXyA) in your [VMware Cloud on AWS](https://aws.amazon.com/vmware/) or [VMware vSphere](https://docs.vmware.com/en/VMware-vSphere/index.html) on‑premises environment. You can configure the content library as one of three types: standalone, publisher, or subscriber.
This Terraform module creates or imports a [datastore](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-storage/GUID-7BED10DD-3EF2-4670-BA7F-0EEB4EC6EB85.html)‑backed [content library](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-254B2CE8-20A8-43F0-90E8-3F6776C2C896.html) in your [VMware Cloud on AWS](https://aws.amazon.com/vmware/) or [VMware vSphere](https://docs.vmware.com/en/VMware-vSphere/index.html) on‑premises environment. You can configure the content library as one of three types: standalone, publisher, or subscriber.

You can optionally specify a list of new [items](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-D3DD122F-16A5-4F36-8467-97994A854B16.html), such as OVA and ISO images, to deploy into the new or existing content library or a list of items to import from an existing content library.
You can optionally specify a list of new [items](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-D3DD122F-16A5-4F36-8467-97994A854B16.html), such as OVA and ISO images, to deploy into the new or existing content library or a list of items to import from an existing content library.

## Usage

Expand All @@ -11,7 +11,7 @@ You can optionally specify a list of new [items](https://docs.vmware.com/en/VMwa
```hcl
module "vsphere_content_library" {
source = "aws-ia/content-library/vsphere"
version = ">= 0.0.1"
version = ">= 1.0.0"
datacenter_name = "SDDC-Datacenter"
datastore_name = "WorkloadDatastore"
Expand All @@ -26,7 +26,7 @@ module "vsphere_content_library" {
```hcl
module "vsphere_content_library" {
source = "aws-ia/content-library/vsphere"
version = ">= 0.0.1"
version = ">= 1.0.0"
datacenter_name = "SDDC-Datacenter"
datastore_name = "WorkloadDatastore"
Expand All @@ -36,9 +36,9 @@ module "vsphere_content_library" {
create_content_library_items = true
content_library_items = [
{
name = "vmware-tools-windows-11.3.0-18"
name = "vmware-tools-windows-12.0.6-20"
description = "VMware Tools for Windows."
file_url = "https://packages.vmware.com/tools/esx/7.0u3/windows/VMware-tools-windows-11.3.0-18090558.iso"
file_url = "https://packages.vmware.com/tools/esx/8.0/windows/VMware-tools-windows-12.0.6-20104755.iso"
type = "iso"
},
]
Expand All @@ -50,16 +50,16 @@ module "vsphere_content_library" {
```hcl
module "vsphere_content_library" {
source = "aws-ia/content-library/vsphere"
version = ">= 0.0.1"
version = ">= 1.0.0"
content_library_name = "example-content-library"
create_content_library = false
create_content_library_items = true
content_library_items = [
{
name = "vmware-tools-windows-11.3.0-18"
name = "vmware-tools-windows-12.0.6-20"
description = "VMware Tools for Windows."
file_url = "https://packages.vmware.com/tools/esx/7.0u3/windows/VMware-tools-windows-11.3.0-18090558.iso"
file_url = "https://packages.vmware.com/tools/esx/8.0/windows/VMware-tools-windows-12.0.6-20104755.iso"
type = "iso"
},
]
Expand All @@ -71,14 +71,14 @@ module "vsphere_content_library" {
```hcl
module "vsphere_content_library" {
source = "aws-ia/content-library/vsphere"
version = ">= 0.0.1"
version = ">= 1.0.0"
content_library_name = "example-content-library"
create_content_library = false
create_content_library_items = false
content_library_items = [
{
name = "vmware-tools-windows-11.3.0-18"
name = "vmware-tools-windows-12.0.6-20"
description = ""
file_url = "n/a"
type = "iso"
Expand All @@ -92,7 +92,7 @@ module "vsphere_content_library" {
```hcl
module "vsphere_content_library" {
source = "aws-ia/content-library/vsphere"
version = ">= 0.0.1"
version = ">= 1.0.0"
content_library_name = "example-publisher"
create_content_library = true
Expand All @@ -108,7 +108,7 @@ module "vsphere_content_library" {
```hcl
module "vsphere_content_library" {
source = "aws-ia/content-library/vsphere"
version = ">= 0.0.1"
version = ">= 1.0.0"
content_library_name = "example-subscriber"
create_content_library = true
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ repos:
- repo: https://github.com/aws-ia/pre-commit-configs
# To update run:
# pre-commit autoupdate --freeze
rev: 82b2dd4f3c3c8b064ce15c7cc518e14c43f6a068 # frozen: v1.4.1
rev: c7091ec774495a41986bd9c5ea59152655ec4f3a # frozen: v1.6.2
hooks:
- id: aws-ia-meta-hook
2 changes: 1 addition & 1 deletion .tflint.hcl
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

plugin "aws" {
enabled = true
version = "0.12.0"
version = "0.21.1"
source = "github.com/terraform-linters/tflint-ruleset-aws"
}

Expand Down
2 changes: 1 addition & 1 deletion NOTICE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Copyright 2016-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at

Expand Down
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!-- BEGIN_TF_DOCS -->
# vSphere Content Library Terraform Module

This Terraform module creates or imports a [datastore](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.storage.doc/GUID-7BED10DD-3EF2-4670-BA7F-0EEB4EC6EB85.html)&#8209;backed [content library](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-254B2CE8-20A8-43F0-90E8-3F6776C2C896.html?hWord=N4IghgNiBcIMYHsB2AXApqgBBAlgIwCcwCBPEAXyA) in your [VMware Cloud on AWS](https://aws.amazon.com/vmware/) or [VMware vSphere](https://docs.vmware.com/en/VMware-vSphere/index.html) on&#8209;premises environment. You can configure the content library as one of three types: standalone, publisher, or subscriber.
This Terraform module creates or imports a [datastore](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-storage/GUID-7BED10DD-3EF2-4670-BA7F-0EEB4EC6EB85.html)&#8209;backed [content library](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-254B2CE8-20A8-43F0-90E8-3F6776C2C896.html) in your [VMware Cloud on AWS](https://aws.amazon.com/vmware/) or [VMware vSphere](https://docs.vmware.com/en/VMware-vSphere/index.html) on&#8209;premises environment. You can configure the content library as one of three types: standalone, publisher, or subscriber.

You can optionally specify a list of new [items](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-D3DD122F-16A5-4F36-8467-97994A854B16.html), such as OVA and ISO images, to deploy into the new or existing content library or a list of items to import from an existing content library.
You can optionally specify a list of new [items](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-D3DD122F-16A5-4F36-8467-97994A854B16.html), such as OVA and ISO images, to deploy into the new or existing content library or a list of items to import from an existing content library.

## Usage

Expand All @@ -12,7 +12,7 @@ You can optionally specify a list of new [items](https://docs.vmware.com/en/VMwa
```hcl
module "vsphere_content_library" {
source = "aws-ia/content-library/vsphere"
version = ">= 0.0.1"
version = ">= 1.0.0"
datacenter_name = "SDDC-Datacenter"
datastore_name = "WorkloadDatastore"
Expand All @@ -27,7 +27,7 @@ module "vsphere_content_library" {
```hcl
module "vsphere_content_library" {
source = "aws-ia/content-library/vsphere"
version = ">= 0.0.1"
version = ">= 1.0.0"
datacenter_name = "SDDC-Datacenter"
datastore_name = "WorkloadDatastore"
Expand All @@ -37,9 +37,9 @@ module "vsphere_content_library" {
create_content_library_items = true
content_library_items = [
{
name = "vmware-tools-windows-11.3.0-18"
name = "vmware-tools-windows-12.0.6-20"
description = "VMware Tools for Windows."
file_url = "https://packages.vmware.com/tools/esx/7.0u3/windows/VMware-tools-windows-11.3.0-18090558.iso"
file_url = "https://packages.vmware.com/tools/esx/8.0/windows/VMware-tools-windows-12.0.6-20104755.iso"
type = "iso"
},
]
Expand All @@ -51,16 +51,16 @@ module "vsphere_content_library" {
```hcl
module "vsphere_content_library" {
source = "aws-ia/content-library/vsphere"
version = ">= 0.0.1"
version = ">= 1.0.0"
content_library_name = "example-content-library"
create_content_library = false
create_content_library_items = true
content_library_items = [
{
name = "vmware-tools-windows-11.3.0-18"
name = "vmware-tools-windows-12.0.6-20"
description = "VMware Tools for Windows."
file_url = "https://packages.vmware.com/tools/esx/7.0u3/windows/VMware-tools-windows-11.3.0-18090558.iso"
file_url = "https://packages.vmware.com/tools/esx/8.0/windows/VMware-tools-windows-12.0.6-20104755.iso"
type = "iso"
},
]
Expand All @@ -72,14 +72,14 @@ module "vsphere_content_library" {
```hcl
module "vsphere_content_library" {
source = "aws-ia/content-library/vsphere"
version = ">= 0.0.1"
version = ">= 1.0.0"
content_library_name = "example-content-library"
create_content_library = false
create_content_library_items = false
content_library_items = [
{
name = "vmware-tools-windows-11.3.0-18"
name = "vmware-tools-windows-12.0.6-20"
description = ""
file_url = "n/a"
type = "iso"
Expand All @@ -93,7 +93,7 @@ module "vsphere_content_library" {
```hcl
module "vsphere_content_library" {
source = "aws-ia/content-library/vsphere"
version = ">= 0.0.1"
version = ">= 1.0.0"
content_library_name = "example-publisher"
create_content_library = true
Expand All @@ -109,7 +109,7 @@ module "vsphere_content_library" {
```hcl
module "vsphere_content_library" {
source = "aws-ia/content-library/vsphere"
version = ">= 0.0.1"
version = ">= 1.0.0"
content_library_name = "example-subscriber"
create_content_library = true
Expand Down Expand Up @@ -156,12 +156,12 @@ No modules.
|------|-------------|------|---------|:--------:|
| <a name="input_authentication_method"></a> [authentication\_method](#input\_authentication\_method) | Method for authenticating users if creating a publication/subscription relationship between content libraries. | `string` | `null` | no |
| <a name="input_content_library_description"></a> [content\_library\_description](#input\_content\_library\_description) | The description of the vSphere content library. | `string` | `null` | no |
| <a name="input_content_library_items"></a> [content\_library\_items](#input\_content\_library\_items) | List of maps of strings defining either OVA/OVF or ISO vSphere content library items (https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-D3DD122F-16A5-4F36-8467-97994A854B16.html). At this time, VM template items are not supported by this module, but can be easily added separately. Each map must have the following keys: 'name', 'description', 'file\_url', and 'type'. The value for each 'type' key must be set to either 'ovf' or 'iso'. Last, only the value for 'description' can be empty. | `list(map(string))` | `[]` | no |
| <a name="input_content_library_name"></a> [content\_library\_name](#input\_content\_library\_name) | The name of the vSphere content library (https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-254B2CE8-20A8-43F0-90E8-3F6776C2C896.html?hWord=N4IghgNiBcIMYHsB2AXApqgBBAlgIwCcwCBPEAXyA). | `string` | `"Content library"` | no |
| <a name="input_content_library_items"></a> [content\_library\_items](#input\_content\_library\_items) | List of maps of strings defining either OVA/OVF or ISO vSphere content library items (https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-D3DD122F-16A5-4F36-8467-97994A854B16.html). At this time, VM template items are not supported by this module, but can be easily added separately. Each map must have the following keys: 'name', 'description', 'file\_url', and 'type'. The value for each 'type' key must be set to either 'ovf' or 'iso'. Last, only the value for 'description' can be empty. | `list(map(string))` | `[]` | no |
| <a name="input_content_library_name"></a> [content\_library\_name](#input\_content\_library\_name) | The name of the vSphere content library (https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-254B2CE8-20A8-43F0-90E8-3F6776C2C896.html). | `string` | `"Content library"` | no |
| <a name="input_create_content_library"></a> [create\_content\_library](#input\_create\_content\_library) | If true, a new vSphere content library will be created; otherwise, the corresponding content library will be imported as a data source. | `bool` | `false` | no |
| <a name="input_create_content_library_items"></a> [create\_content\_library\_items](#input\_create\_content\_library\_items) | If true, new vSphere content library items will be created for each specified; otherwise, the corresponding content library items will be imported as a data source. | `bool` | `false` | no |
| <a name="input_datacenter_name"></a> [datacenter\_name](#input\_datacenter\_name) | The name of the vSphere datacenter object where the content library will be created (https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-7FDFBDBE-F8AC-4D00-AE5E-3F14D7472FAF.html). | `string` | `"SDDC-Datacenter"` | no |
| <a name="input_datastore_name"></a> [datastore\_name](#input\_datastore\_name) | The name of the vSphere datastore object where the content library items will be stored (https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.storage.doc/GUID-7BED10DD-3EF2-4670-BA7F-0EEB4EC6EB85.html). | `string` | `"WorkloadDatastore"` | no |
| <a name="input_datacenter_name"></a> [datacenter\_name](#input\_datacenter\_name) | The name of the vSphere datacenter object where the content library will be created (https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-7FDFBDBE-F8AC-4D00-AE5E-3F14D7472FAF.html). | `string` | `"SDDC-Datacenter"` | no |
| <a name="input_datastore_name"></a> [datastore\_name](#input\_datastore\_name) | The name of the vSphere datastore object where the content library items will be stored (https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-storage/GUID-7BED10DD-3EF2-4670-BA7F-0EEB4EC6EB85.html). | `string` | `"WorkloadDatastore"` | no |
| <a name="input_password"></a> [password](#input\_password) | Password if creating a publication/subscription relationship between content libraries with authentication. Password length and complexity requirements are determined by the configuration in vCenter. | `string` | `null` | no |
| <a name="input_publication_published"></a> [publication\_published](#input\_publication\_published) | If true, publish the content library if creating a publication/subscription relationship between content libraries. | `bool` | `null` | no |
| <a name="input_subscription_automatic_sync"></a> [subscription\_automatic\_sync](#input\_subscription\_automatic\_sync) | If true, enable automatic synchronization with the published library if creating a publication/subscription relationship between content libraries. | `bool` | `null` | no |
Expand Down
2 changes: 1 addition & 1 deletion examples/basic/.header.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Basic example

If deployed with the default values, this example will create a [content library](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-254B2CE8-20A8-43F0-90E8-3F6776C2C896.html?hWord=N4IghgNiBcIMYHsB2AXApqgBBAlgIwCcwCBPEAXyA) named `example-content-library` backed by a [datastore](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.storage.doc/GUID-7BED10DD-3EF2-4670-BA7F-0EEB4EC6EB85.html) named `WorkloadDatastore`, and one ISO [item](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-D3DD122F-16A5-4F36-8467-97994A854B16.html) named `vmware-tools-windows-11.3.0-18` in your [VMware Cloud on AWS](https://aws.amazon.com/vmware/) or [VMware vSphere](https://docs.vmware.com/en/VMware-vSphere/index.html) on&#8209;premises environment.
If deployed with the default values, this example will create a [content library](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-254B2CE8-20A8-43F0-90E8-3F6776C2C896.html) named `example-content-library` backed by a [datastore](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-storage/GUID-7BED10DD-3EF2-4670-BA7F-0EEB4EC6EB85.html) named `WorkloadDatastore`, and one ISO [item](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-D3DD122F-16A5-4F36-8467-97994A854B16.html) named `vmware-tools-windows-11.3.0-18` in your [VMware Cloud on AWS](https://aws.amazon.com/vmware/) or [VMware vSphere](https://docs.vmware.com/en/VMware-vSphere/index.html) on&#8209;premises environment.

## Usage

Expand Down
Loading

0 comments on commit e80d041

Please sign in to comment.