From 9f20b75e9239bb1d514443f74f9d11f794442002 Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Tue, 19 Mar 2024 10:33:31 +0000 Subject: [PATCH 1/5] update valid values --- .../docs/managers/rse-api-manager.md | 6 +-- .../managers/zos-console-oeconsol-manager.md | 2 +- .../docs/managers/zos-manager.md | 44 +++++++++---------- .../docs/managers/zos-mf-manager.md | 4 +- .../managers/zos-tso-command-ssh-manager.md | 2 +- 5 files changed, 29 insertions(+), 29 deletions(-) diff --git a/src/markdown-pages/docs/managers/rse-api-manager.md b/src/markdown-pages/docs/managers/rse-api-manager.md index 21704756..07ab9746 100644 --- a/src/markdown-pages/docs/managers/rse-api-manager.md +++ b/src/markdown-pages/docs/managers/rse-api-manager.md @@ -40,8 +40,8 @@ The following are properties used to configure the RSE API Manager. | Name: | rseapi.server.[imageid].https | | Description: | Use https (SSL) for RSE API server | | Required: | No | -| Default value: | True | -| Valid values: | $validValues | +| Default value: | true | +| Valid values: | true or false | | Examples: | rseapi.server.https=true
rseapi.server.RSESYSA.https=true | @@ -111,7 +111,7 @@ The following are properties used to configure the RSE API Manager. | Description: | The port number of the RSE API server | | Required: | no | | Default value: | 6800 | -| Valid values: | $validValues | +| Valid values: | A valid port number | | Examples: | rseapi.server.port=6800
rseapi.server.RSESYSA.port=6800 | diff --git a/src/markdown-pages/docs/managers/zos-console-oeconsol-manager.md b/src/markdown-pages/docs/managers/zos-console-oeconsol-manager.md index 676ce473..efa4f645 100644 --- a/src/markdown-pages/docs/managers/zos-console-oeconsol-manager.md +++ b/src/markdown-pages/docs/managers/zos-console-oeconsol-manager.md @@ -25,7 +25,7 @@ The following are properties used to configure the zOS Console oeconsol Manager. | Description: | The path to the oeconsol command | | Required: | No | | Default value: | oeconsol | -| Valid values: | $validValues | +| Valid values: | A valid PATH environment variable or a full path name | | Examples: | zosconsole.oeconsole.command.path=oeconsol
zosconsole.MFSYSA.oeconsol.command.path=/tools/oeconsol where /tools/oeconsol is the locations of the oeconsol executable| diff --git a/src/markdown-pages/docs/managers/zos-manager.md b/src/markdown-pages/docs/managers/zos-manager.md index 642419bf..c72ae80b 100644 --- a/src/markdown-pages/docs/managers/zos-manager.md +++ b/src/markdown-pages/docs/managers/zos-manager.md @@ -70,7 +70,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The name of the Bundle that implements the z/OS Batch Manager | | Required: | No | | Default value: | dev.galasa.common.zosbatch.zosmf.manager | -| Valid values: | $validValues | +| Valid values: | A 1 - 8 length character name. A cluster name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. Valid characters are A-Z, a - z, 0-9, special characters. | | Examples: | zos.bundle.extra.batch.manager=dev.galasa.common.zosbatch.zosmf.manager
| @@ -84,7 +84,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The z/OS Cluster ID for the specified tag | | Required: | No | | Default value: | None | -| Valid values: | $validValues | +| Valid values: | A valid z/OS cluster ID | | Examples: | zos.tag.[tag].clusterid=plex1
| @@ -98,7 +98,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The z/OS Images for the specified cluster | | Required: | No | | Default value: | None | -| Valid values: | $validValues | +| Valid values: | A valid z/OS image | | Examples: | zos.cluster.[clusterId].images=SYSA,SYSB,SYSC
| @@ -112,7 +112,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The name of the Bundle that implements the z/OS Console Manager | | Required: | No | | Default value: | dev.galasa.common.zosconsole.zosmf.manager | -| Valid values: | $validValues | +| Valid values: | A 1 - 8 length character name. A cluster name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. Valid characters are A-Z, a - z, 0-9, special characters. | | Examples: | zos.bundle.extra.console.manager=dev.galasa.common.zosconsole.zosmf.manager
| @@ -126,7 +126,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The Cluster ID for the specified tag | | Required: | No | | Default value: | None | -| Valid values: | $validValues | +| Valid values: | A cluster name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. | | Examples: | zos.dse.tag.[tag].clusterid=PLEXA
| @@ -140,7 +140,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The image ID of the Developer Supplied Environment for the specified tag | | Required: | No | | Default value: | None | -| Valid values: | $validValues | +| Valid values: | A valid image ID | | Examples: | zos.dse.tag.[tag].imageid=SYSA
| @@ -154,7 +154,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The name of the Bundle that implements the z/OS File Manager | | Required: | No | | Default value: | dev.galasa.common.zosfile.zosmf.manager | -| Valid values: | $validValues | +| Valid values: | A 1 - 8 length character name. A cluster name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. Valid characters are A-Z, a - z, 0-9, special characters. | | Examples: | zos.bundle.extra.file.manager=dev.galasa.common.zosfile.zosmf.manager
| @@ -168,7 +168,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The IP Host ID of the z/OS Image for the supplied tag.
If CPS property zos.image.[tag].iphostid exists, then that is returned, otherwise the z/OS Image ID is returned | | Required: | No | | Default value: | None | -| Valid values: | $validValues | +| Valid values: | A valid IP Host ID | | Examples: | zos.image.[tag].iphostid=sysa.ibm.com
| @@ -182,7 +182,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The image ID for the specified tag | | Required: | No | | Default value: | None | -| Valid values: | $validValues | +| Valid values: | A valid z/OS image ID | | Examples: | zos.dse.tag.[tag].imageid=SYSA
| @@ -196,7 +196,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The maximum slots available on a z/OS Image for the specified tag | | Required: | No | | Default value: | 2 | -| Valid values: | $validValues | +| Valid values: | 1 to 255 | | Examples: | zos.image.[tag].max.slots=2
| @@ -221,10 +221,10 @@ The following properties are used to configure the z/OS Manager. | Property: | The SYSNAME for zOS Image | | --------------------------------------- | :------------------------------------- | | Name: | zos.image.[imageid].sysname | -| Description: | The SYSNAME for the z/OS image | +| Description: | The SYSNAME for the z/OS image | | Required: | No | | Default value: | The image ID of the image | -| Valid values: | $validValues | +| Valid values: | The name must be 1-8 characters long; the valid characters are A-Z, 0-9, $, @, and #. | | Examples: | zos.image.IMAGEA.sysname=SYSA
| @@ -238,7 +238,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The data set HLQ(s) for temporary data sets created on z/OS Image.
If CPS property zos.run.[image].dataset.hlq exists, then that is returned | | Required: | No | | Default value: | runuser.GALASA | -| Valid values: | $validValues | +| Valid values: | A data set name can be one name segment, or a series of joined name segments. Segments are limited to eight characters, the first of which must be alphabetic (A to Z) or special (# @ $). The remaining seven characters are either alphabetic, numeric (0 - 9), special, a hyphen (-). Name segments are separated by a period (.). | | Examples: | zos.run.[image].dataset.hlq=USERID.GALASA
| @@ -252,7 +252,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The UNIX path prefix for temporary data sets created on z/OS Image.
If CPS property zos.run.[image].unix.path.prefix exists, then that is returned | | Required: | No | | Default value: | /u/runuser/Galasa | -| Valid values: | $validValues | +| Valid values: | A valid path | | Examples: | zos.run.[image].unix.path.prefix=/u/userid/Galasa
| @@ -266,7 +266,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The name of the Bundle that implements the z/OS TSO Command Manager | | Required: | No | | Default value: | dev.galasa.zostsocommand.ssh.manager | -| Valid values: | $validValues | +| Valid values: | A 1 - 8 length character name. A cluster name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. Valid characters are A-Z, a - z, 0-9, special characters. | | Examples: | zos.bundle.extra.tsocommand.manager=dev.galasa.zostsocommand.ssh.manager | @@ -280,7 +280,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The name of the Bundle that implements the z/OS UNIX Command Manager | | Required: | No | | Default value: | dev.galasa.zosunixcommand.ssh.manager | -| Valid values: | $validValues | +| Valid values: | A 1 - 8 length character name. A cluster name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. Valid characters are A-Z, a - z, 0-9, special characters. | | Examples: | zos.bundle.extra.unix.manager=dev.galasa.zosunixcommand.ssh.manager | @@ -405,8 +405,8 @@ The following properties are used to configure the z/OS Manager. | Name: | zosconsole.console.[imageid].restrict.to.image | | Description: | Use only the zOSMF server running on the image associated with the z/OS Console | | Required: | No | -| Default value: | False | -| Valid values: | $validValues | +| Default value: | false | +| Valid values: | true or false | | Examples: | zosconsole.console.restrict.to.image=true
zosconsole.console.SYSA.restrict.to.image=true | @@ -420,7 +420,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The maximum number of items the server (e.g. zOSMF, RSE API, etc) returns when listing the content of a UNIX directory | | Required: | No | | Default value: | 1000 | -| Valid values: | $validValues | +| Valid values: | 0 to 65535 | | Examples: | zosfile.unix.[imageid].directory.list.max.items=1000
| @@ -433,8 +433,8 @@ The following properties are used to configure the z/OS Manager. | Name: | zosfile.file.[imageid].restrict.to.image | | Description: | Use only the server (e.g. zOSMF, RSE API, etc) running on the image associated with the z/OS data set or file | | Required: | No | -| Default value: | False | -| Valid values: | $validValues | +| Default value: | false | +| Valid values: | true or false | | Examples: | zosfile.file.restrict.to.image=true
zosfile.file.SYSA.restrict.to.image=true | @@ -448,7 +448,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The UNIX file or directory permission bits to be used in creating the file or directory | | Required: | No | | Default value: | None | -| Valid values: | $validValues | +| Valid values: | Valid values are r,w,x,s,- | | Examples: | zosfile.unix.file.permission=rwxrwx---
zosfile.SYSA.unix.file.permission=rwxrwxrrx | diff --git a/src/markdown-pages/docs/managers/zos-mf-manager.md b/src/markdown-pages/docs/managers/zos-mf-manager.md index 78ca64a4..388a7bba 100644 --- a/src/markdown-pages/docs/managers/zos-mf-manager.md +++ b/src/markdown-pages/docs/managers/zos-mf-manager.md @@ -40,8 +40,8 @@ The following are properties used to configure the zOS MF Manager. | Name: | zosmf.server.[imageid].https | | Description: | Use https (SSL) for zOSMF server | | Required: | No | -| Default value: | True | -| Valid values: | $validValues | +| Default value: | true | +| Valid values: | true or false | | Examples: | zosmf.server.https=true
zosmf.server.SYSA.https=true | diff --git a/src/markdown-pages/docs/managers/zos-tso-command-ssh-manager.md b/src/markdown-pages/docs/managers/zos-tso-command-ssh-manager.md index 57b2c311..1d610c8e 100644 --- a/src/markdown-pages/docs/managers/zos-tso-command-ssh-manager.md +++ b/src/markdown-pages/docs/managers/zos-tso-command-ssh-manager.md @@ -25,7 +25,7 @@ The following are properties used to configure the zOS TSO Command SSH Manager. | Description: | The path to the tsocmd command | | Required: | No | | Default value: | tsocmd | -| Valid values: | $validValues | +| Valid values: | A valid PATH environment variable or a full path name | | Examples: | zostsocommand.command.tsocmd.path=tsocmd
zostsocommand.MFSYSA.tsocmd.command.path=/tools/tsocmd | From 84c5fad305e4afa54432e1aca9155af185f46a99 Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Tue, 19 Mar 2024 10:48:16 +0000 Subject: [PATCH 2/5] update valid values --- .../docs/managers/zos-manager.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/markdown-pages/docs/managers/zos-manager.md b/src/markdown-pages/docs/managers/zos-manager.md index c72ae80b..196c5383 100644 --- a/src/markdown-pages/docs/managers/zos-manager.md +++ b/src/markdown-pages/docs/managers/zos-manager.md @@ -70,7 +70,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The name of the Bundle that implements the z/OS Batch Manager | | Required: | No | | Default value: | dev.galasa.common.zosbatch.zosmf.manager | -| Valid values: | A 1 - 8 length character name. A cluster name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. Valid characters are A-Z, a - z, 0-9, special characters. | +| Valid values: | A 1 - 8 length character name. A name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. Valid characters are A-Z, a - z, 0-9, special characters. | | Examples: | zos.bundle.extra.batch.manager=dev.galasa.common.zosbatch.zosmf.manager
| @@ -84,7 +84,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The z/OS Cluster ID for the specified tag | | Required: | No | | Default value: | None | -| Valid values: | A valid z/OS cluster ID | +| Valid values: | Valid value is a character string with a maximum length of 32 | | Examples: | zos.tag.[tag].clusterid=plex1
| @@ -95,10 +95,10 @@ The following properties are used to configure the z/OS Manager. | Property: | The images for a zOS Cluster | | --------------------------------------- | :------------------------------------- | | Name: | zos.cluster.[clusterId].images | -| Description: | The z/OS Images for the specified cluster | +| Description: | The z/OS Images for the specified cluster. Specify more than one image by using commas. | | Required: | No | | Default value: | None | -| Valid values: | A valid z/OS image | +| Valid values: | Valid value is a character string with a maximum length of 32 | | Examples: | zos.cluster.[clusterId].images=SYSA,SYSB,SYSC
| @@ -112,7 +112,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The name of the Bundle that implements the z/OS Console Manager | | Required: | No | | Default value: | dev.galasa.common.zosconsole.zosmf.manager | -| Valid values: | A 1 - 8 length character name. A cluster name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. Valid characters are A-Z, a - z, 0-9, special characters. | +| Valid values: | A 1 - 8 length character name. A name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. Valid characters are A-Z, a - z, 0-9, special characters. | | Examples: | zos.bundle.extra.console.manager=dev.galasa.common.zosconsole.zosmf.manager
| @@ -126,7 +126,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The Cluster ID for the specified tag | | Required: | No | | Default value: | None | -| Valid values: | A cluster name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. | +| Valid values: | A 1 - 8 length character name | | Examples: | zos.dse.tag.[tag].clusterid=PLEXA
| @@ -154,7 +154,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The name of the Bundle that implements the z/OS File Manager | | Required: | No | | Default value: | dev.galasa.common.zosfile.zosmf.manager | -| Valid values: | A 1 - 8 length character name. A cluster name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. Valid characters are A-Z, a - z, 0-9, special characters. | +| Valid values: | A 1 - 8 length character name. A name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. Valid characters are A-Z, a - z, 0-9, special characters. | | Examples: | zos.bundle.extra.file.manager=dev.galasa.common.zosfile.zosmf.manager
| @@ -266,7 +266,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The name of the Bundle that implements the z/OS TSO Command Manager | | Required: | No | | Default value: | dev.galasa.zostsocommand.ssh.manager | -| Valid values: | A 1 - 8 length character name. A cluster name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. Valid characters are A-Z, a - z, 0-9, special characters. | +| Valid values: | A 1 - 8 length character name. A name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. Valid characters are A-Z, a - z, 0-9, special characters. | | Examples: | zos.bundle.extra.tsocommand.manager=dev.galasa.zostsocommand.ssh.manager | @@ -280,7 +280,7 @@ The following properties are used to configure the z/OS Manager. | Description: | The name of the Bundle that implements the z/OS UNIX Command Manager | | Required: | No | | Default value: | dev.galasa.zosunixcommand.ssh.manager | -| Valid values: | A 1 - 8 length character name. A cluster name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. Valid characters are A-Z, a - z, 0-9, special characters. | +| Valid values: | A 1 - 8 length character name. A name containing more than 8 characters must be segmented by periods; 1 to 8 characters can be specified between periods. Valid characters are A-Z, a - z, 0-9, special characters. | | Examples: | zos.bundle.extra.unix.manager=dev.galasa.zosunixcommand.ssh.manager | From 3160f9f3297e2b88f39856f7fd6febaca99ce148 Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Tue, 19 Mar 2024 11:30:31 +0000 Subject: [PATCH 3/5] fix link --- src/markdown-pages/highlights.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/markdown-pages/highlights.md b/src/markdown-pages/highlights.md index 83629e3f..7b0a01a5 100644 --- a/src/markdown-pages/highlights.md +++ b/src/markdown-pages/highlights.md @@ -5,7 +5,7 @@ title: "Highlights" # Galasa Delivery -Galasa is an open source project and is delivered using a continuous delivery model. There are instructions on [getting started](https://galasa.dev/docs/cli-command-reference/cli-command-reference) on this site. +Galasa is an open source project and is delivered using a continuous delivery model. There are instructions on [getting started](https://galasa.dev/docs) on this site. Post a question or share your experiences with other users in our Galasa Slack workspace. Register to join first if you're not yet a member. From 6249ab06426997fe0e2c0c9fc92d5076ff1adf21 Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Tue, 19 Mar 2024 11:56:51 +0000 Subject: [PATCH 4/5] prereq to publish --- src/markdown-pages/highlights.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/markdown-pages/highlights.md b/src/markdown-pages/highlights.md index 83629e3f..b8311962 100644 --- a/src/markdown-pages/highlights.md +++ b/src/markdown-pages/highlights.md @@ -5,7 +5,7 @@ title: "Highlights" # Galasa Delivery -Galasa is an open source project and is delivered using a continuous delivery model. There are instructions on [getting started](https://galasa.dev/docs/cli-command-reference/cli-command-reference) on this site. +Galasa is an open source project and is delivered by using a continuous delivery model. There are instructions on [getting started](https://galasa.dev/docs/cli-command-reference/cli-command-reference) on this site. Post a question or share your experiences with other users in our Galasa Slack workspace. Register to join first if you're not yet a member. From 3b942593b070c1318f01b3c91f793a47c0d89e66 Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Tue, 19 Mar 2024 11:59:04 +0000 Subject: [PATCH 5/5] publish fix prereq --- src/markdown-pages/highlights.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/markdown-pages/highlights.md b/src/markdown-pages/highlights.md index b8311962..83629e3f 100644 --- a/src/markdown-pages/highlights.md +++ b/src/markdown-pages/highlights.md @@ -5,7 +5,7 @@ title: "Highlights" # Galasa Delivery -Galasa is an open source project and is delivered by using a continuous delivery model. There are instructions on [getting started](https://galasa.dev/docs/cli-command-reference/cli-command-reference) on this site. +Galasa is an open source project and is delivered using a continuous delivery model. There are instructions on [getting started](https://galasa.dev/docs/cli-command-reference/cli-command-reference) on this site. Post a question or share your experiences with other users in our Galasa Slack workspace. Register to join first if you're not yet a member.