Skip to content

Commit

Permalink
Update README.md for categories and extra_configs
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverkurth committed Oct 25, 2023
1 parent 470735c commit 5f79032
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,13 +164,23 @@ environment:
transports:
- com.vmware.guestInfo
- iso
categories:
email: Email Settings
properties:
guestinfo.admin.email:
value: [email protected]
user_configurable: true
type: string
description: "The Admin's email address"
label: "Email Address"
category: email
extra_configs:
feature.enabled:
required: false
value: true
log.rotateSize:
value: 2048000
product:
product: An Example VM
Expand Down Expand Up @@ -217,7 +227,8 @@ configurations:
description: just right
```
The default can also be set with `default_configuration` in the `system` section.
* `environment` is for setting OVF properties. Variables are added under the new `environment` section as a `properties` map. The key is the name of the variable. Each variable has a mandatory `type`. `value`, `user_configurable` (default: `false`), `qualifiers`, `password` (default `false`),`label`, `description` are optional. Additionally, `transports` can be set in a list. Valid values are `iso` and `com.vmware.guestInfo`. Note that at least one of them must be set to make the properties visible inside the guest.
* `environment` is for setting OVF properties. Variables are added under the new `environment` section as a `properties` map. The key is the name of the variable. Each variable has a mandatory `type`. `value`, `user_configurable` (default: `false`), `qualifiers`, `password` (default `false`),`label`, `description` are optional. Additionally, `transports` can be set in a list. Valid values are `iso` and `com.vmware.guestInfo`. Note that at least one of them must be set to make the properties visible inside the guest. Optionally, categories are set with `categories` to a map with an id as key and a description as value. Each property can have a `category` set to a category id.
* `extra_configs` is a map of settings with the fields `value` and optionally the boolean `required`.
* `annotation` has the fields `info`, `text` and `file`. `text` and `file` are mutually exclusive - `text` is text inline, `file` can be set to a text file that will be filled in. The annotation text will appear for example as a comment in VMware Fusion.
* `eula` also has the fields `info`, `text` and `file`. It contains the EULA agreement the user has to agree to when deploying the VM.

Expand Down

0 comments on commit 5f79032

Please sign in to comment.