From f1d0d8f7aceef3534cec690f9fb5c97a1b5f652e Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Wed, 20 Mar 2024 11:07:28 +0000 Subject: [PATCH 1/6] get managers in right format --- .../docs/managers/artifact-manager.md | 13 ++++++++---- .../docs/managers/cics-ts-ceci-manager.md | 15 ++++++++----- .../docs/managers/cics-ts-manager.md | 14 +++++++++---- .../docs/managers/core-manager.md | 3 ++- .../docs/managers/docker-manager.md | 21 +++++++++++++------ .../docs/managers/elasticlog-manager.md | 13 ++++++++---- .../docs/managers/galasa-ecosystem-manager.md | 18 ++++++++++------ .../docs/managers/galasa_ecosystem-manager.md | 17 ++++++++++----- .../docs/managers/http-client-manager.md | 14 +++++++++---- .../docs/managers/ipnetwork-manager.md | 8 +++++-- .../docs/managers/jmeter-manager.md | 14 +++++++++---- .../docs/managers/kubernetes-manager.md | 17 ++++++++++----- .../docs/managers/linux-manager.md | 13 ++++++++---- .../docs/managers/mq-manager.md | 15 +++++++++---- .../docs/managers/open-stack-manager.md | 8 ++++--- .../docs/managers/rse-api-manager.md | 15 +++++++++---- .../docs/managers/selenium-manager.md | 15 ++++++++----- .../docs/managers/vtp-manager.md | 13 ++++++++---- .../managers/z-os-batch-rse-api-manager.md | 5 +++-- .../managers/z-os-batch-z-os-mf-manager.md | 5 +++-- .../docs/managers/z-os-file-manager.md | 18 ++++++++++------ .../docs/managers/z-os-file-zos-mf-manager.md | 5 +++-- .../docs/managers/zos-batch-manager.md | 13 ++++++++---- .../docs/managers/zos-batch-zos-mf-manager.md | 5 +++-- .../docs/managers/zos-console-manager.md | 15 +++++++------ .../managers/zos-console-oeconsol-manager.md | 12 ++++++++--- .../managers/zos-console-zos-mf-manager.md | 4 ++-- .../docs/managers/zos-file-manager.md | 14 +++++++++---- .../docs/managers/zos-file-zos-mf-manager.md | 5 +++-- .../docs/managers/zos-managertestformat.md | 14 +++++++++---- .../docs/managers/zos-mf-manager.md | 14 +++++++++---- .../managers/zos-tso-command-ssh-manager.md | 12 +++++++---- .../managers/zos-unix-command-ssh-manager.md | 5 +++-- 33 files changed, 269 insertions(+), 123 deletions(-) diff --git a/src/markdown-pages/docs/managers/artifact-manager.md b/src/markdown-pages/docs/managers/artifact-manager.md index fc178e04..4ab52a11 100644 --- a/src/markdown-pages/docs/managers/artifact-manager.md +++ b/src/markdown-pages/docs/managers/artifact-manager.md @@ -3,15 +3,20 @@ path: "/docs/managers/artifact-manager" title: "Artifact Manager" --- -**Release** +This Manager is at Release level. You can view the Javadoc documentation for the Manager here.
-## Overview -This Manager allows a test to access files that are stored within the same bundle as the test code itself. Helper methods are provided to stream and substitute symbolics within the loaded file.

You can view the Javadoc documentation for this Manager here.

+[Overview](#overview)
+[Code snippets and examples](#codesnippets)
+# Overview -## Code snippets +This Manager allows a test to access files that are stored within the same bundle as the test code itself. Helper methods are provided to stream and substitute symbolics within the loaded file.

+ + + +## Code snippets Use the following code snippets to help you get started with the Artifact Manager. diff --git a/src/markdown-pages/docs/managers/cics-ts-ceci-manager.md b/src/markdown-pages/docs/managers/cics-ts-ceci-manager.md index ed72b292..1bd52f4f 100644 --- a/src/markdown-pages/docs/managers/cics-ts-ceci-manager.md +++ b/src/markdown-pages/docs/managers/cics-ts-ceci-manager.md @@ -3,13 +3,18 @@ path: "/docs/managers/cics-ts-ceci-manager" title: "CICS TS CECI Manager" --- -**Release** +This Manager is at Release level. You can view the Javadoc documentation for the Manager here.
-## Overview -This Manager allows Galasa tests to issue CICS/TS CECI commands.

Use the command-level interpreter (CECI) Manager to request a CECI instance in a Galasa test, issue basic CECI commands which can be processed interactively on a 3270 screen and retrieve results. Examples of using this Manager can include writing data to a temporary storage queue, linking to a CICS program or retrieving the signed on user id.

You can view the Javadoc documentation here.

+[Overview](#overview)
+[Provided annotation](#annotations)
+[Code snippets and examples](#codesnippets)
-## Annotations +# Overview +This Manager allows Galasa tests to issue CICS/TS CECI commands.

Use the command-level interpreter (CECI) Manager to request a CECI instance in a Galasa test, issue basic CECI commands which can be processed interactively on a 3270 screen and retrieve results. Examples of using this Manager can include writing data to a temporary storage queue, linking to a CICS program or retrieving the signed on user id.

+ + +## Provided annotation The following annotations are available with the CICS TS CECI Manager
@@ -26,7 +31,7 @@ The following annotations are available with the CICS TS CECI Manager -## Code snippets +## Code snippets Use the following code snippets to help you get started with the CICS TS CECI Manager. diff --git a/src/markdown-pages/docs/managers/cics-ts-manager.md b/src/markdown-pages/docs/managers/cics-ts-manager.md index 084888f9..66a6fdb5 100644 --- a/src/markdown-pages/docs/managers/cics-ts-manager.md +++ b/src/markdown-pages/docs/managers/cics-ts-manager.md @@ -3,16 +3,22 @@ path: "/docs/managers/cics-ts-manager" title: "CICS TS Manager" --- -**Alpha - This Manager is being actively developed. It is subject to change and has not been extensively tested.** +This Manager is at Alpha level. You can view the Javadoc documentation for the Manager here.
-## Overview -This manager provides Galasa tests to CICS/TS functions.

+[Overview](#overview)
+[Configuring](#configuring)
+[Provided annotation](#annotations)
+[Code snippets and examples](#codesnippets)
+# Overview +This Manager provides Galasa tests to CICS/TS functions.

-## Configuration Properties + + +## Configuration Properties The following are properties used to configure the CICS TS Manager. diff --git a/src/markdown-pages/docs/managers/core-manager.md b/src/markdown-pages/docs/managers/core-manager.md index 01321a0c..cf9fec11 100644 --- a/src/markdown-pages/docs/managers/core-manager.md +++ b/src/markdown-pages/docs/managers/core-manager.md @@ -3,7 +3,8 @@ path: "/docs/managers/core-manager" title: "Core Manager" --- -This Manager is at Release level. You can view the Javadoc documentation for the Manager here.
+This Manager is at Release level. You can view the Javadoc documentation for the Manager here.
+ [Overview](#overview)
diff --git a/src/markdown-pages/docs/managers/docker-manager.md b/src/markdown-pages/docs/managers/docker-manager.md index cde17a97..bd5a221d 100644 --- a/src/markdown-pages/docs/managers/docker-manager.md +++ b/src/markdown-pages/docs/managers/docker-manager.md @@ -3,16 +3,25 @@ path: "/docs/managers/docker-manager" title: "Docker Manager" --- -**Release** +This Manager is at Release level. You can view the Javadoc documentation for the Manager here.
+ + + +[Overview](#overview)
+[Provided annotation](#annotations)
+[Code snippets and examples](#codesnippets)
+[Configuring](#configuring)
+ + +# Overview -## Overview This Manager enables tests to run Docker Containers on a Docker Engine provided by the Galasa infrastructure, making it easy to write tests that consume container-based services. The test does not need to worry about where the Docker infrastructure is, its credentials, or its capacity as this is all handled by the Manager.

The Docker Manager can be used by other Managers as a base for their own services. For example, the JMeter Manager can run a JMeter service inside a Docker Container. Using the Docker Manager in this way means that the test or administration team do not need to create dedicated JMeter resources.

Containers that are provided by the Docker Manager can be used to either drive workload for the application under test, or to receive workload from the application. The Docker Manager can also be used to monitor the test or to provide a security context like OpenLDAP. Docker Containers provide a powerful tool in helping test applications in an integrated environment.

The Docker Manager supports Galasa Shared Environments. Shared Environments provide the ability to create a test environment that can be shared across multiple test runs so you don't have to provision a test environment for each test. ## Limitations -The Docker Manager supports only AMD64 platforms. It is planned to expand the capability to S390x.

The Docker Manager currently supports only a single Docker Engine. It is planned to allow multiple Docker Engines to be configured.

You can view the Javadoc documentation for the Manager here.

+The Docker Manager supports only AMD64 platforms. It is planned to expand the capability to S390x.

The Docker Manager currently supports only a single Docker Engine. It is planned to allow multiple Docker Engines to be configured.

-## Annotations +## Annotations The following annotations are available with the Docker Manager
@@ -61,7 +70,7 @@ The following annotations are available with the Docker Manager -## Code snippets +## Code snippets Use the following code snippets to help you get started with the Docker Manager. @@ -134,7 +143,7 @@ String log = httpContainer.getStdOut();
-## Configuration Properties +## Configuration Properties The following are properties used to configure the Docker Manager. diff --git a/src/markdown-pages/docs/managers/elasticlog-manager.md b/src/markdown-pages/docs/managers/elasticlog-manager.md index d56ced02..6476d02b 100644 --- a/src/markdown-pages/docs/managers/elasticlog-manager.md +++ b/src/markdown-pages/docs/managers/elasticlog-manager.md @@ -3,19 +3,24 @@ path: "/docs/managers/elasticlog-manager" title: "ElasticLog Manager" --- -**ALPHA - This Manager is being actively developed. It is subject to change and has not been extensively tested. It is available for Galasa administrators to utilise to experiment with Elasticsearch and Kibana dashboards** +This Manager is at Alpha level.
-## Overview + +[Overview](#overview)
+[Configuring](#configuring)
+ + +# Overview This Manager exports test results to an elastic search endpoint, where the data can be visualized on a Kibana dashboard. Other Managers can contribute to the information that is exported to Elastic.

As an absolute minimum, the CPS properties
elasticlog.endpoint.address
and
elasticlog.endpoint.index
must be provided. By default, this Manager only logs automated tests. To enable logging from locally run tests,
elasticlog.local.run.log must be set to true.
The bundle must also be loaded by the framework by using
framework.extra.bundles=dev.galasa.elasticlog.manager
in bootstrap.properties.

This Manager provides two ElasticSearch indexes; one of all test data, and one of the latest run for each test case and each test environment. ## Limitations -The Manager logs the following test information:

- testCase
- runId
- startTimestamp
- endTimestamp
- requestor
- result
- testTooling
- testType
- testingEnvironment
- productRelease
- buildLevel
- customBuild
- testingAreas
- tags

If additional testing information is required, please raise a GitHub issue.

You can view the Javadoc documentation for the Manager here.

+The Manager logs the following test information:

- testCase
- runId
- startTimestamp
- endTimestamp
- requestor
- result
- testTooling
- testType
- testingEnvironment
- productRelease
- buildLevel
- customBuild
- testingAreas
- tags

If additional testing information is required, please raise a GitHub issue.

-## Configuration Properties +## Configuration Properties The following are properties used to configure the ElasticLog Manager. diff --git a/src/markdown-pages/docs/managers/galasa-ecosystem-manager.md b/src/markdown-pages/docs/managers/galasa-ecosystem-manager.md index 81423d2f..0e2202d1 100644 --- a/src/markdown-pages/docs/managers/galasa-ecosystem-manager.md +++ b/src/markdown-pages/docs/managers/galasa-ecosystem-manager.md @@ -3,16 +3,22 @@ path: "/docs/managers/galasa-ecosystem-manager" title: "Galasa Ecosystem Manager" --- -**ALPHA - This Manager is being actively developed. It is subject to change and has not been extensively tested.** +This Manager is at Alpha level. You can view the Javadoc documentation for the Manager here.
-## Overview + + +[Overview](#overview)
+[Provided annotation](#annotations)
+[Code snippets and examples](#codesnippets)
+ + +# Overview This Manager provides the test with a fully provisioned Galasa Ecosystem on which to test. When the test starts running the test can be assured that all the services are up and working.

The Galasa Ecosystem Manager supports Galasa Shared Environments. Shared Environments provide the ability to create a test environment that can be shared across multiple test runs so you don't have to provision a test environment for each test. ## Limitations -The Manager only supports the following platforms:
- Kubernetes Namespace

In the near future, this Manager will be able to provision ecosystems in Docker and on a plain Linux server.

You can view the Javadoc documentation for the Manager here.

- +The Manager only supports the following platforms:
- Kubernetes Namespace

In the near future, this Manager will be able to provision ecosystems in Docker and on a plain Linux server.

-## Annotations +## Annotations The following annotations are available with the Galasa Ecosystem Manager
@@ -49,7 +55,7 @@ The following annotations are available with the Galasa Ecosystem Manager -## Code snippets +## Code snippets Use the following code snippets to help you get started with the Galasa Ecosystem Manager. diff --git a/src/markdown-pages/docs/managers/galasa_ecosystem-manager.md b/src/markdown-pages/docs/managers/galasa_ecosystem-manager.md index a48b6399..fb11e0c9 100644 --- a/src/markdown-pages/docs/managers/galasa_ecosystem-manager.md +++ b/src/markdown-pages/docs/managers/galasa_ecosystem-manager.md @@ -3,16 +3,23 @@ path: "/docs/managers/galasa_ecosystem-manager" title: "Galasa Ecosystem Manager" --- -**ALPHA - This Manager has been written to provide a Galasa Ecsosystem for the Galasa integrated test pipeline. It has the bare minimum code necessary to do that. It has not been extensively tested (other than on the pipeline). The TPI is subject to change. However, saying all that, it can be used within tests.** +This Manager is at Alpha level. You can view the Javadoc documentation for the Manager here.
-## Overview -This Manager will provide the Test with a fully provisioned Galasa Ecosystem to test on. When the Test starts running the Test can be assured that all the services are up and working.

The Galasa Ecosystem Manager supports Galasa Shared Environments. Shared Environments provide the ability to create a test environment that can be shared across multiple test runs so you don't have to provision a test environment for each test. You can view the Javadoc documentation for the Manager here.

+ + +[Overview](#overview)
+[Provided annotation](#annotations)
+[Code snippets and examples](#codesnippets)
+ + +# Overview +This Manager will provide the Test with a fully provisioned Galasa Ecosystem to test on. When the Test starts running the Test can be assured that all the services are up and working.

The Galasa Ecosystem Manager supports Galasa Shared Environments. Shared Environments provide the ability to create a test environment that can be shared across multiple test runs so you don't have to provision a test environment for each test. ## Limitations The Manager only supports the following platforms:-
Kubernetes Namespace

In the near future, this Manager will be able to provision Ecosystems in Docker and a plain Linux server -## Annotations +## Annotations The following annotations are available with the Galasa Ecosystem Manager @@ -26,7 +33,7 @@ The following annotations are available with the Galasa Ecosystem Manager | Syntax: | @KubernetesEcosystem
public IKubernetesEcosystem ecosystem;

@KubernetesEcosystem(yamlDirectory="/k8syaml"
public IKubernetesEcosystem ecosystem;
 | | Notes: | The IKubernetesEcosystem interface gives the test access to the URLs to all the services and API endpoints within the Ecosystem. When the test starts to run, all the services will be up and verified.

The Test must provide a @KubernetesNamespace IKubernetesNamespace annotation, as this will be where the Ecosystem will be provisioned in. In the future, Docker and Linux will be options.
The Galasa Ecosystem has it's own stable versions of the Kubernetes YAML files necessary to create the entire Ecosystem. If you wish to override those and use your own YAML files, then use the yamlDirectory attribute. If a resource is missing in the test's set, then the stable version will be used. | -## Code Snippets +## Code Snippets Use the following code snippets to help you get started with the Galasa Ecosystem Manager. diff --git a/src/markdown-pages/docs/managers/http-client-manager.md b/src/markdown-pages/docs/managers/http-client-manager.md index ba7a051e..cdca041d 100644 --- a/src/markdown-pages/docs/managers/http-client-manager.md +++ b/src/markdown-pages/docs/managers/http-client-manager.md @@ -3,12 +3,18 @@ path: "/docs/managers/http-client-manager" title: "HTTP Client Manager" --- -**Release** +This Manager is at Release level. You can view the Javadoc documentation for the Manager here.
-## Overview -This Manager provides a variety of common HTTP client operations you can use in your tests. For example, you can use this Manager in a test where you want to determine if a particular web page contains (or does not contain) some specific content. This is exactly how it is used in the Docker Manager IVT (Installation Verification Test). As well as providing client functionality to people who write tests, it may also be used internally by other Managers to enrich their range of offered services. This Manager supports outbound HTTP calls, JSON requests, HTTP file transfer and Web Services calls. SSL is supported. You can view the Javadoc documentation for the Manager here.

-## Code snippets + +[Overview](#overview)
+[Code snippets and examples](#codesnippets)
+ + +# Overview +This Manager provides a variety of common HTTP client operations you can use in your tests. For example, you can use this Manager in a test where you want to determine if a particular web page contains (or does not contain) some specific content. This is exactly how it is used in the Docker Manager IVT (Installation Verification Test). As well as providing client functionality to people who write tests, it may also be used internally by other Managers to enrich their range of offered services. This Manager supports outbound HTTP calls, JSON requests, HTTP file transfer and Web Services calls. SSL is supported.

+ +## Code snippets Use the following code snippets to help you get started with the HTTP Client Manager. diff --git a/src/markdown-pages/docs/managers/ipnetwork-manager.md b/src/markdown-pages/docs/managers/ipnetwork-manager.md index 14a76ced..6732ce7b 100644 --- a/src/markdown-pages/docs/managers/ipnetwork-manager.md +++ b/src/markdown-pages/docs/managers/ipnetwork-manager.md @@ -3,10 +3,14 @@ path: "/docs/managers/ipnetwork-manager" title: "IP Network Manager" --- -**Alpha** +This Manager is at Release level. You can view the Javadoc documentation for the Manager here.
+ + + +# Overview ## Overview -The IP Network Manager enables access to applications over TCP/IP networks for those applications whose native communication is over TCP/IP. It can be used by other application specific managers that will build upon the basic address capabilities provided by the IP Network Manager.

The Manager interrogates the Configuration Properties Store (CPS) to get hostname and port information so that you do not need to hard-code these values into your tests.

You can view the Javadoc documentation for the Manager here.

+The IP Network Manager enables access to applications over TCP/IP networks for those applications whose native communication is over TCP/IP. It can be used by other application specific managers that will build upon the basic address capabilities provided by the IP Network Manager.

The Manager interrogates the Configuration Properties Store (CPS) to get hostname and port information so that you do not need to hard-code these values into your tests.

diff --git a/src/markdown-pages/docs/managers/jmeter-manager.md b/src/markdown-pages/docs/managers/jmeter-manager.md index 94fbfe44..71bcb8e6 100644 --- a/src/markdown-pages/docs/managers/jmeter-manager.md +++ b/src/markdown-pages/docs/managers/jmeter-manager.md @@ -3,18 +3,24 @@ path: "/docs/managers/jmeter-manager" title: "JMeter Manager" --- -**BETA - This Manager is almost ready. It has been tested and the TPI is stable, but there may be minor changes to come.** +This Manager is at Beta level. You can view the Javadoc documentation for the Manager here.
-## Overview + + +[Overview](#overview)
+[Code snippets and examples](#codesnippets)
+ + +# Overview This Manager enables a JMeter session to run inside a Docker Container. The JMeter Manager requests a container from the Docker Manager inside which the JMeter scripts, or JMX files can run. The test can access all JMeter-generated files inside the container without worrying about how the container is provisioned, maintained or shut down at the end of test. By using a containerized environment, the test can benefit from the associated standards of scalability and uniformity.



The logfiles and generated CSV files can be accessed once the JMeter tests are complete and the container becomes available for interaction. The JMeter Manager allows as many JMeter sessions as you have available Docker container slots on your machine. ## Limitations -JMeter tests cannot be run remotely on a target host.

You can view the Javadoc documentation for the Manager here.

+JMeter tests cannot be run remotely on a target host.

-## Code snippets +## Code snippets Use the following code snippets to help you get started with the JMeter Manager. diff --git a/src/markdown-pages/docs/managers/kubernetes-manager.md b/src/markdown-pages/docs/managers/kubernetes-manager.md index f1861ca6..771940e0 100644 --- a/src/markdown-pages/docs/managers/kubernetes-manager.md +++ b/src/markdown-pages/docs/managers/kubernetes-manager.md @@ -3,16 +3,23 @@ path: "/docs/managers/kubernetes-manager" title: "Kubernetes Manager" --- -**ALPHA - This Manager is being actively developed. It is subject to change and has not been extensively tested.** +This Manager is at Alpha level. You can view the Javadoc documentation for the Manager here.
-## Overview + + +[Overview](#overview)
+[Provided annotation](#annotations)
+[Code snippets and examples](#codesnippets)
+ + +# Overview This Manager provides a test with a Kubernetes Namespace to utilize. The test will provide YAML representations of the resources that the test requires.

As an absolute minimum, the CPS property kubernetes.cluster.K8S.url must be provided as well as a credential secure.credentials.K8S.token for the API token.

The Kubernetes Manager supports Galasa Shared Environments. Shared environments provide the ability to create a test environment that can be shared across multiple test runs so you don't have to provision a test environment for each test. ## Limitations -The Manager only supports the following Kubernetes resources:-

- Deployment
- StatefulSet
- Service
- Secret
- ConfigMap
- PersistentVolumeClaim

If additional resources are required, please raise a GitHub issue.

You can view the Javadoc documentation for the Manager here.

+The Manager only supports the following Kubernetes resources:-

- Deployment
- StatefulSet
- Service
- Secret
- ConfigMap
- PersistentVolumeClaim

If additional resources are required, please raise a GitHub issue.

-## Annotations +## Annotations The following annotations are available with the Kubernetes Manager
@@ -30,7 +37,7 @@ The following annotations are available with the Kubernetes Manager -## Code snippets +## Code snippets Use the following code snippets to help you get started with the Kubernetes Manager. diff --git a/src/markdown-pages/docs/managers/linux-manager.md b/src/markdown-pages/docs/managers/linux-manager.md index 9ff0d469..40a5f792 100644 --- a/src/markdown-pages/docs/managers/linux-manager.md +++ b/src/markdown-pages/docs/managers/linux-manager.md @@ -3,16 +3,21 @@ path: "/docs/managers/linux-manager" title: "Linux Manager" --- -**Alpha** +This Manager is at Alpha level. You can view the Javadoc documentation for the Manager here.
-## Overview -This Manager provides the tester with the capability to connect to a Linux image as part of a test and to access the command shell. Standard commands can then be run on the image. The Linux Manager has a dependency on the IP Network Manager, which establishes an IP connection to the image. You can view the Javadoc documentation for the Manager here.

+[Overview](#overview)
+[Configuring](#configuring)
+# Overview +This Manager provides the tester with the capability to connect to a Linux image as part of a test and to access the command shell. Standard commands can then be run on the image. The Linux Manager has a dependency on the IP Network Manager, which establishes an IP connection to the image.

-## Configuration Properties + + + +## Configuration Properties The following are properties used to configure the Linux Manager. diff --git a/src/markdown-pages/docs/managers/mq-manager.md b/src/markdown-pages/docs/managers/mq-manager.md index 0c9b182a..4da4a0c9 100644 --- a/src/markdown-pages/docs/managers/mq-manager.md +++ b/src/markdown-pages/docs/managers/mq-manager.md @@ -3,12 +3,19 @@ path: "/docs/managers/mq-manager" title: "MQ Manager" --- -**Alpha** +This Manager is at Alpha level. You can view the Javadoc documentation for the Manager here.
-## Overview + + +[Overview](#overview)
+[Provided annotation](#annotations)
+[Code snippets and examples](#codesnippets)
+ + +# Overview This Manager provides the ability to connect a test to an existing IBM MQ queue manager, enabling one or more messages to be written to and read from existing queues.

-## Annotations +## Annotations The following annotations are available with the MQ Manager
@@ -41,7 +48,7 @@ The following annotations are available with the MQ Manager -## Code snippets +## Code snippets Use the following code snippets to help you get started with the MQ Manager. Use the MQ Manager to connect a test to an existing IBM MQ queue manager and queue. Galasa does not provision new IBM MQ queue managers or queues. diff --git a/src/markdown-pages/docs/managers/open-stack-manager.md b/src/markdown-pages/docs/managers/open-stack-manager.md index a88ff57c..d3e9d147 100644 --- a/src/markdown-pages/docs/managers/open-stack-manager.md +++ b/src/markdown-pages/docs/managers/open-stack-manager.md @@ -3,10 +3,12 @@ path: "/docs/managers/open-stack-manager" title: "Open Stack Manager" --- -**Alpha** +This Manager is at Alpha level. You can view the Javadoc documentation for the Manager here.
-## Overview -This Manager enables Galasa to provision Linux images on a provided Open Stack instance. Use the Open Stack Manager to create the instances and to set up the networking required to make the images accessible to the tester. The Open Stack Manager has a dependency on the Linux Manager.

You can view the Javadoc documentation for the Manager here.

+ + +# Overview +This Manager enables Galasa to provision Linux images on a provided Open Stack instance. Use the Open Stack Manager to create the instances and to set up the networking required to make the images accessible to the tester. The Open Stack Manager has a dependency on the Linux Manager.

diff --git a/src/markdown-pages/docs/managers/rse-api-manager.md b/src/markdown-pages/docs/managers/rse-api-manager.md index 07ab9746..0521fd07 100644 --- a/src/markdown-pages/docs/managers/rse-api-manager.md +++ b/src/markdown-pages/docs/managers/rse-api-manager.md @@ -3,13 +3,20 @@ path: "/docs/managers/rse-api-manager" title: "RSE API Manager" --- -**ALPHA - This Manager is being actively developed. It is subject to change and has not been extensively tested.** +This Manager is at Alpha level. You can view the Javadoc documentation for the Manager here.
-## Overview + + +[Overview](#overview)
+[Provided annotation](#annotations)
+[Configuring](#configuring)
+ + +# Overview This Manager provides Galasa tests with access to a RSE API server. -## Annotations +## Provided annotations The following annotations are available with the RSE API Manager
@@ -28,7 +35,7 @@ The following annotations are available with the RSE API Manager -## Configuration Properties +## Configuration Properties The following are properties used to configure the RSE API Manager. diff --git a/src/markdown-pages/docs/managers/selenium-manager.md b/src/markdown-pages/docs/managers/selenium-manager.md index 1cd83b7c..a9cf5602 100644 --- a/src/markdown-pages/docs/managers/selenium-manager.md +++ b/src/markdown-pages/docs/managers/selenium-manager.md @@ -3,18 +3,23 @@ path: "/docs/managers/selenium-manager" title: "Selenium Manager" --- -**BETA - This Manager is almost ready. It has been tested and the TPI is stable, but there may be minor changes to come.** +This Manager is at Beta level. You can view the Javadoc documentation for the Manager here.
-## Overview + + +[Overview](#overview)
+[Code snippets and examples](#codesnippets)
+ + +# Overview This Manager enables the test to run Selenium WebDrivers in order to drive Web Browsers during the test. Browsers can have actions performed against them to navigate WebPages and extract information about the current page.

As an absolute minimum, the CPS property
selenium.instance.PRIMARY.gecko.path
must be provided as the Manager will default to using a GECKO WebDriver if no WebDriver is provided.

The CPS property
selenium.instance.PRIMARY.web.driver
can be used to set a different WebDriver. This will also require the corresponding driver path to be set.
eg. selenium.instance.PRIMARY.web.driver=CHROME
requires selenium.instance.PRIMARY.chrome.path=...
## Limitations -The Selenium Manager only supports GECKO, CHROME, EDGE and IE WebDrivers.

You can view the Javadoc documentation for the Manager here.

- +The Selenium Manager only supports GECKO, CHROME, EDGE and IE WebDrivers.

-## Code snippets +## Code snippets Use the following code snippets to help you get started with the Selenium Manager. diff --git a/src/markdown-pages/docs/managers/vtp-manager.md b/src/markdown-pages/docs/managers/vtp-manager.md index 8bd4395d..4379186d 100644 --- a/src/markdown-pages/docs/managers/vtp-manager.md +++ b/src/markdown-pages/docs/managers/vtp-manager.md @@ -3,9 +3,14 @@ path: "/docs/managers/vtp-manager" title: "VTP Manager" --- -**Release** - -## Overview +This Manager is at Release level.
+ + +[Overview](#overview)
+[Configuring](#configuring)
+ + +# Overview Create an automated integration test in Galasa and use the VTP Manager to transparently record the interactions between the test and your CICS programs. Play back the recorded file by using IBM Z Virtual Test Platform (ZVTP). Playing back the recording in ZVTP means that you can test a change to your application code without running the test inside CICS. Run the recorded tests as part of your regression testing strategy before and after code changes to detect any anomalies. @@ -30,7 +35,7 @@ To enable VTP recording, set ```vtp.recording.enable``` to _true_ in the CPS pro If VTP recording is enabled but no fields annotated with @CICSRegion are contained in the test class, the following message is returned _VTP Recording enabled but test class contains no CICS TS fields - recording will not be attempted_. -## CPS properties +## CPS properties The following properties are used to configure the VTP Manager. diff --git a/src/markdown-pages/docs/managers/z-os-batch-rse-api-manager.md b/src/markdown-pages/docs/managers/z-os-batch-rse-api-manager.md index 75bd2faf..67863f10 100644 --- a/src/markdown-pages/docs/managers/z-os-batch-rse-api-manager.md +++ b/src/markdown-pages/docs/managers/z-os-batch-rse-api-manager.md @@ -3,9 +3,10 @@ path: "/docs/managers/z-os-batch-rse-api-manager" title: "z/OS Batch RSE API Manager" --- -**ALPHA - This Manager is being actively developed. It is subject to change and has not been extensively tested.** +This Manager is at Alpha level. You can view the Javadoc documentation for the Manager here.
-## Overview + +# Overview This Manager is an internal implementation of the z/OS Batch Manager using RSE API. The RSE API Batch Manager is used in conjunction with the z/OS Manager. The z/OS Manager provides the interface for the z/OS batch function and pulls in the RSE API Batch Manager to provide the implementation of the interface. If your test needs to submit or monitor a batch job or retrieve output from a batch job, you can call the z/OS Manager in your test code and the z/OS Manager will call the RSE API Batch Manager to provide the implementation via the z/OS batch function. For example, the BatchAccountsOpenTest uses the z/OS Manager (which in the background, invokes RSE API) to add a set of accounts to the Galasa SimBank system via a z/OS batch job.

The zOS Batch RSE API Manager is enabled by setting the CPS property: zos.bundle.extra.batch.manager=dev.galasa.zosbatch.rseapi.manager

See the zOS Manager for details of the z/OS Batch annotations and code snippets. diff --git a/src/markdown-pages/docs/managers/z-os-batch-z-os-mf-manager.md b/src/markdown-pages/docs/managers/z-os-batch-z-os-mf-manager.md index dd2b7661..56c4bd3f 100644 --- a/src/markdown-pages/docs/managers/z-os-batch-z-os-mf-manager.md +++ b/src/markdown-pages/docs/managers/z-os-batch-z-os-mf-manager.md @@ -3,9 +3,10 @@ path: "/docs/managers/z-os-batch-z-os-mf-manager" title: "z/OS Batch z/OS MF Manager" --- -**BETA - This Manager is feature complete but may contain known or unknown bugs.** +This Manager is at Beta level. You can view the Javadoc documentation for the Manager here.
-## Overview + +# Overview This Manager is an internal implementation of the z/OS Batch Manager using z/OS MF. The z/OS MF Batch Manager is used in conjunction with the z/OS Manager. The z/OS Manager provides the interface for the z/OS batch function and pulls in the z/OS MF Batch Manager to provide the implementation of the interface. If your test needs to submit or monitor a batch job or retrieve output from a batch job, you can call the z/OS Manager in your test code and the z/OS Manager will call the z/OS MF Batch Manager to provide the implementation via the z/OS batch function. For example, the BatchAccountsOpenTest uses the z/OS Manager (which in the background, invokes z/OS MF) to add a set of accounts to the Galasa SimBank system via a z/OS batch job.

The zOS Batch z/OS MF Manager is enabled by setting the CPS property:
zos.bundle.extra.batch.manager=dev.galasa.zosbatch.zosmf.manager
Galasa sets this property by default.

See the zOS Manager for details of the z/OS Batch annotations and code snippets. diff --git a/src/markdown-pages/docs/managers/z-os-file-manager.md b/src/markdown-pages/docs/managers/z-os-file-manager.md index a1d2b02f..2aa2d510 100644 --- a/src/markdown-pages/docs/managers/z-os-file-manager.md +++ b/src/markdown-pages/docs/managers/z-os-file-manager.md @@ -3,13 +3,21 @@ path: "/docs/managers/z-os-file-manager" title: "z/OS file Manager" --- -**BETA** +This Manager is at Beta level. You can view the Javadoc documentation for the Manager here.
-## Overview + + +[Overview](#overview)
+[Configuring](#configuring)
+[Provided annotation](#annotations)
+[Code snippets and examples](#codesnippets)
+ + +# Overview This Manager enables Galasa tests to manage data sets and UNIX files on a z/OS image.

The Manager is implemented using the z/OS MF Manager by default.

-## Annotations +## Annotations The following annotations are available with the z/OS file Manager @@ -38,7 +46,7 @@ The following annotations are available with the z/OS file Manager | Syntax: | @ZosFileHandler
public IZosFileHandler zosFileHandler;
 | | Notes: | The IZosFileHandler interface has three methods supplying file name and z/OS image:
{@link IZosFileHandler#newDataset(String, dev.galasa.zos.IZosImage)}
{@link IZosFileHandler#newVSAMDataset(String, dev.galasa.zos.IZosImage)}
{@link IZosFileHandler#newUNIXFile(String, dev.galasa.zos.IZosImage)}
returning an object representing the type of file requested. This can be an existing file or can be created via a method on the file object.

See ZosFileHandler, IZosFileHandler, IZosDataset, IZosVSAMDataset and IZosUNIXFile to find out more. | -## Code Snippets +## Code Snippets Use the following code snippets to help you get started with the z/OS file Manager. @@ -291,6 +299,4 @@ vsamDataSet.setRecordSize(50, 101); vsamDataSet.create(); ``` -### Read a zOS UNIX File -*To be completed...* diff --git a/src/markdown-pages/docs/managers/z-os-file-zos-mf-manager.md b/src/markdown-pages/docs/managers/z-os-file-zos-mf-manager.md index fec8b121..b1efeb38 100644 --- a/src/markdown-pages/docs/managers/z-os-file-zos-mf-manager.md +++ b/src/markdown-pages/docs/managers/z-os-file-zos-mf-manager.md @@ -3,9 +3,10 @@ path: "/docs/managers/z-os-file-zos-mf-manager" title: "z/OS File zOS/MF Manager" --- -**BETA - This Manager is feature complete but may contain known or unknown bugs.** +This Manager is at Beta level. You can view the Javadoc documentation for the Manager here.
-## Overview + +# Overview This Manager is an internal implementation of the z/OS File Manager using zOS/MF. The z/OS MF File Manager is used in conjunction with the z/OS Manager. The z/OS Manager provides the interface for the z/OS file function and pulls in the z/OS MF File Manager to provide the implementation of the interface. If your test needs to instantiate a UNIX file, dataset, or VSAM data set, write and retrieve content from it, or configure and manipulate it then you can call the z/OS Manager in your test code and the z/OS Manager will call the z/OS MF File Manager to provide the implementation via the z/OS file function.

The z/OS File zOS/MF Manager is enabled by setting the CPS property:
zos.bundle.extra.file.manager=dev.galasa.zosfile.rseapi.manager
Galasa sets this property by default.

See the zOS Manager for details of the z/OS File Annotations. diff --git a/src/markdown-pages/docs/managers/zos-batch-manager.md b/src/markdown-pages/docs/managers/zos-batch-manager.md index fe34e023..bff4c332 100644 --- a/src/markdown-pages/docs/managers/zos-batch-manager.md +++ b/src/markdown-pages/docs/managers/zos-batch-manager.md @@ -3,13 +3,18 @@ path: "/docs/managers/zos-batch-manager" title: "zOS Batch Manager" --- -**BETA** +This Manager is at Beta level. You can view the Javadoc documentation for the Manager here.
-## Overview +[Overview](#overview)
+[Provided annotation](#annotations)
+[Code snippets and examples](#codesnippets)
+ + +# Overview This Manager enables Galasa tests to submit batch jobs to run on a z/OS image.

The Manager is implemented using the z/OS MF Manager by default.

-## Annotations +## Provided annotations The following annotations are available with the zOS Batch Manager @@ -38,7 +43,7 @@ The following annotations are available with the zOS Batch Manager | Syntax: | @ZosFileHandler
public IZosFileHandler zosFileHandler;
 | | Notes: | The IZosFileHandler interface has three methods supplying file name and z/OS image:
{@link IZosFileHandler#newDataset(String, dev.galasa.zos.IZosImage)}
{@link IZosFileHandler#newVSAMDataset(String, dev.galasa.zos.IZosImage)}
{@link IZosFileHandler#newUNIXFile(String, dev.galasa.zos.IZosImage)}
returning an object representing the type of file requested. This can be an existing file or can be created via a method on the file object.

See ZosFileHandler, IZosFileHandler, IZosDataset, IZosVSAMDataset and IZosUNIXFile to find out more. | -## Code Snippets +## Code Snippets Use the following code snippets to help you get started with the zOS Batch Manager. diff --git a/src/markdown-pages/docs/managers/zos-batch-zos-mf-manager.md b/src/markdown-pages/docs/managers/zos-batch-zos-mf-manager.md index c0a5ef38..335e476a 100644 --- a/src/markdown-pages/docs/managers/zos-batch-zos-mf-manager.md +++ b/src/markdown-pages/docs/managers/zos-batch-zos-mf-manager.md @@ -3,9 +3,10 @@ path: "/docs/managers/zos-batch-zos-mf-manager" title: "zOS Batch zOS MF Manager" --- -**BETA** +This Manager is at Beta level. -## Overview + +# Overview This Manager is the internal implementation of the zOS Batch Manager using zOS/MF.

You can view the Javadoc documentation for the Manager here.

diff --git a/src/markdown-pages/docs/managers/zos-console-manager.md b/src/markdown-pages/docs/managers/zos-console-manager.md index a05c6207..c5efdad7 100644 --- a/src/markdown-pages/docs/managers/zos-console-manager.md +++ b/src/markdown-pages/docs/managers/zos-console-manager.md @@ -3,13 +3,18 @@ path: "/docs/managers/zos-console-manager" title: "zOS Console Manager" --- -**BETA** +This Manager is at Beta level. You can view the Javadoc documentation for the Manager here.
-## Overview +[Overview](#overview)
+[Provided annotation](#annotations)
+[Code snippets and examples](#codesnippets)
+ + +# Overview This Manager enables Galasa tests to issue console commands on a z/OS image.

The Manager is implemented using the z/OS MF Manager by default.

-## Annotations +## Provided annotations The following annotations are available with the zOS Console Manager @@ -38,7 +43,7 @@ The following annotations are available with the zOS Console Manager | Syntax: | @ZosFileHandler
public IZosFileHandler zosFileHandler;
 | | Notes: | The IZosFileHandler interface has three methods supplying file name and z/OS image:
{@link IZosFileHandler#newDataset(String, dev.galasa.zos.IZosImage)}
{@link IZosFileHandler#newVSAMDataset(String, dev.galasa.zos.IZosImage)}
{@link IZosFileHandler#newUNIXFile(String, dev.galasa.zos.IZosImage)}
returning an object representing the type of file requested. This can be an existing file or can be created via a method on the file object.

See ZosFileHandler, IZosFileHandler, IZosDataset, IZosVSAMDataset and IZosUNIXFile to find out more. | -## Code Snippets +## Code Snippets Use the following code snippets to help you get started with the zOS Console Manager. @@ -291,6 +296,4 @@ vsamDataSet.setRecordSize(50, 101); vsamDataSet.create(); ``` -### Read a zOS UNIX File -*To be completed...* 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 efa4f645..5be8f222 100644 --- a/src/markdown-pages/docs/managers/zos-console-oeconsol-manager.md +++ b/src/markdown-pages/docs/managers/zos-console-oeconsol-manager.md @@ -3,16 +3,22 @@ path: "/docs/managers/zos-console-oeconsol-manager" title: "zOS Console oeconsol Manager" --- -**ALPHA - This Manager is being actively developed. It is subject to change and has not been extensively tested.** +This Manager is at Alpha level. You can view the Javadoc documentation for the Manager here.
-## Overview + + +[Overview](#overview)
+[Configuring](#configuring)
+ + +# Overview This Manager is the internal implementation of the z/OS Console Manager using oeconsol. The oeconsol z/OS Console Manager is used in conjunction with the z/OS UNIX Command Manager. The z/OS Manager provides the interface for the z/OS console function and pulls in the oeconsol Console Manager to provide the implementation of the interface. If your test needs to request a z/OS console instance, issue a console command or retrieve the console command, you can call the z/OS Manager in your test code and the z/OS Manager will call the oeconsol Console Manager to provide the implementation via the z/OS console function. Multiple z/OS console images can be requested by a test.

See the zOS Manager for details of the z/OS Console Annotations.

This implementation is less rich than the zOS/MF implementation due to the restricted functionallity of oeconsol:

  • oeconsol does not directly support console name.
    Console name can be used to avoid clashes with other consoles that the user has open, e.g. in another Galsa test, in a TSO or SDSF session. When supplying console name via IZosConsole#issueCommand(String command, String consoleName) the Manager attempts to obtain credentials from the CPS, i.e. secure.credentials.[consoleName].username. The credentials are used to logon to z/OS UNIX and execute oeconsol with the supplied command.
  • oeconsol does not support retrieving delayed responses.
    A ZosConsoleException is will be thrown when the IZosConsoleCommand#requestResponse() method is called.

See oeconsol for documentation and download -## Configuration Properties +## Configuration Properties The following are properties used to configure the zOS Console oeconsol Manager. diff --git a/src/markdown-pages/docs/managers/zos-console-zos-mf-manager.md b/src/markdown-pages/docs/managers/zos-console-zos-mf-manager.md index 8f97c6fe..290b83a0 100644 --- a/src/markdown-pages/docs/managers/zos-console-zos-mf-manager.md +++ b/src/markdown-pages/docs/managers/zos-console-zos-mf-manager.md @@ -3,9 +3,9 @@ path: "/docs/managers/zos-console-zos-mf-manager" title: "zOS Console zOS MF Manager" --- -**BETA - This Manager is feature complete but may contain known or unknown bugs.** +This Manager is at Beta level. You can view the Javadoc documentation for the Manager here.
-## Overview +# Overview This Manager is the internal implementation of the z/OS Console Manager using zOS/MF. The z/OS MF Console Manager is used in conjunction with the z/OS Manager. The z/OS Manager provides the interface for the z/OS console function and pulls in the z/OS MF Console Manager to provide the implementation of the interface. If your test needs to request a z/OS console instance, issue a console command or retrieve the console command, you can call the z/OS Manager in your test code and the z/OS Manager will call the z/OS MF Console Manager to provide the implementation via the z/OS console function. Multiple z/OS console images can be requested by a test.

See the zOS Manager for details of the z/OS Console Annotations. diff --git a/src/markdown-pages/docs/managers/zos-file-manager.md b/src/markdown-pages/docs/managers/zos-file-manager.md index b319209e..9595a055 100644 --- a/src/markdown-pages/docs/managers/zos-file-manager.md +++ b/src/markdown-pages/docs/managers/zos-file-manager.md @@ -3,13 +3,19 @@ path: "/docs/managers/zos-file-manager" title: "zOS file Manager" --- -**BETA** +This Manager is at Beta level. You can view the Javadoc documentation for the Manager here.
-## Overview + +[Overview](#overview)
+[Provided annotation](#annotations)
+[Code snippets and examples](#codesnippets)
+ + +# Overview This Manager enables Galasa tests to manage data sets and UNIIX files on a zOS image.

The manager is implemented using the zOS/MF Manager by default.

-## Annotations +## Provided annotations The following annotations are available with the zOS file Manager @@ -38,7 +44,7 @@ The following annotations are available with the zOS file Manager | Syntax: | @ZosFileHandler
public IZosFileHandler zosFileHandler;
 | | Notes: | The IZosFileHandler interface has three methods supplying file name and zOS image:
{@link IZosFileHandler#newDataset(String, dev.galasa.zos.IZosImage)}
{@link IZosFileHandler#newVSAMDataset(String, dev.galasa.zos.IZosImage)}
{@link IZosFileHandler#newUNIXFile(String, dev.galasa.zos.IZosImage)}
returning an object representing the type of file requested. This can be an existing file or can be created via a method on the file object.

See ZosFileHandler, IZosFileHandler, IZosDataset, IZosVSAMDataset and IZosUNIXFile to find out more. | -## Code Snippets +## Code Snippets Use the following code snippets to help you get started with the zOS file Manager. diff --git a/src/markdown-pages/docs/managers/zos-file-zos-mf-manager.md b/src/markdown-pages/docs/managers/zos-file-zos-mf-manager.md index eb3962d9..60e5b9f5 100644 --- a/src/markdown-pages/docs/managers/zos-file-zos-mf-manager.md +++ b/src/markdown-pages/docs/managers/zos-file-zos-mf-manager.md @@ -3,9 +3,10 @@ path: "/docs/managers/zos-file-zos-mf-manager" title: "zOS File zOS MF Manager" --- -**BETA** +This Manager is at Beta level. You can view the Javadoc documentation for the Manager here.
-## Overview + +# Overview This Manager is the internal implementation of the zOS File Manager using zOS/MF. The z/OS MF File Manager is used in conjunction with the z/OS Manager. The z/OS Manager provides the interface for the z/OS file function and pulls in the z/OS MF File Manager to provide the implementation of the interface. If your test needs to instantiate a UNIX file, dataset, or VSAM data set, write and retrieve content from it, or configure and manipulate it then you can call the z/OS Manager in your test code and the z/OS Manager will call the z/OS MF File Manager to provide the implementation via the z/OS file function.

See the zOS Manager for details of the z/OS File Annotations. diff --git a/src/markdown-pages/docs/managers/zos-managertestformat.md b/src/markdown-pages/docs/managers/zos-managertestformat.md index 4e632b79..4ff4e9ef 100644 --- a/src/markdown-pages/docs/managers/zos-managertestformat.md +++ b/src/markdown-pages/docs/managers/zos-managertestformat.md @@ -3,12 +3,18 @@ path: "/docs/managers/zos-managertestformat" title: "zOS Manager" --- -**BETA** +This Manager is at Beta level. You can view the Javadoc documentation for the Manager here.
-## Overview + +[Overview](#overview)
+[Provided annotation](#annotations)
+[Code snippets and examples](#codesnippets)
+ + +# Overview This Manager provides Galasa tests with access to a z/OS image. -## Annotations +## Provided annotations

@ZosBatch @@ -45,7 +51,7 @@ This Manager provides Galasa tests with access to a z/OS image. | Notes: | The IZosFileHandler interface has three methods supplying file name and z/OS image:
{@link IZosFileHandler#newDataset(String, dev.galasa.zos.IZosImage)}
{@link IZosFileHandler#newVSAMDataset(String, dev.galasa.zos.IZosImage)}
{@link IZosFileHandler#newUNIXFile(String, dev.galasa.zos.IZosImage)}
returning an object representing the type of file requested. This can be an existing file or can be created via a method on the file object.

See ZosFileHandler, IZosFileHandler, IZosDataset, IZosVSAMDataset and IZosUNIXFile to find out more. |
-## Code Snippets +## Code Snippets
diff --git a/src/markdown-pages/docs/managers/zos-mf-manager.md b/src/markdown-pages/docs/managers/zos-mf-manager.md index 388a7bba..1cb33c2f 100644 --- a/src/markdown-pages/docs/managers/zos-mf-manager.md +++ b/src/markdown-pages/docs/managers/zos-mf-manager.md @@ -3,13 +3,19 @@ path: "/docs/managers/zos-mf-manager" title: "zOS MF Manager" --- -**BETA - This Manager is feature complete but may contain known or unknown bugs.** +This Manager is at Beta level. You can view the Javadoc documentation for the Manager here.
-## Overview + +[Overview](#overview)
+[Provided annotation](#annotations)
+[Configuring](#configuring)
+ + +# Overview This Manager provides Galasa tests with access to a zOS/MF server. Use the z/OS MF Manager to simplify areas of z/OS system management. The z/OS MF Manager can be called from a test or from other Managers. For example, the z/OS Manager calls the z/OS MF Manager to implement z/OS file, console and batch functions via the relevant interface. -## Annotations +## Provided annotations The following annotations are available with the zOS MF Manager
@@ -28,7 +34,7 @@ The following annotations are available with the zOS MF Manager -## Configuration Properties +## Configuration Properties The following are properties used to configure the zOS MF Manager. 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 1d610c8e..fa412050 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 @@ -3,16 +3,20 @@ path: "/docs/managers/zos-tso-command-ssh-manager" title: "zOS TSO Command SSH Manager" --- -**ALPHA - This Manager is being actively developed. It is subject to change and has not been extensively tested.** +This Manager is at Beta level. You can view the Javadoc documentation for the Manager here.
-## Overview -This Manager is the internal implementation of the zOS TSO Command Manager using SSH.

See the zOS Manager for details of the z/OS TSO annotations and code snippets.

You can view the Javadoc documentation for the Manager here.

+[Overview](#overview)
+[Configuring](#configuring)
+# Overview +This Manager is the internal implementation of the zOS TSO Command Manager using SSH.

See the zOS Manager for details of the z/OS TSO annotations and code snippets.

-## Configuration Properties + + +## Configuration Properties The following are properties used to configure the zOS TSO Command SSH Manager. diff --git a/src/markdown-pages/docs/managers/zos-unix-command-ssh-manager.md b/src/markdown-pages/docs/managers/zos-unix-command-ssh-manager.md index 16f77a95..14966d38 100644 --- a/src/markdown-pages/docs/managers/zos-unix-command-ssh-manager.md +++ b/src/markdown-pages/docs/managers/zos-unix-command-ssh-manager.md @@ -3,9 +3,10 @@ path: "/docs/managers/zos-unix-command-ssh-manager" title: "zOS UNIX Command SSH Manager" --- -**ALPHA - This Manager is being actively developed. It is subject to change and has not been extensively tested.** +This Manager is at Beta level. You can view the Javadoc documentation for the Manager here.
-## Overview + +# Overview This Manager is the internal implementation of the z/OS UNIX Command Manager using SSH.

See the zOS Manager for details of the z/OS UNIX annotations and code snippets.

You can view the Javadoc documentation for the Manager here.

From 146c8f7a76a6994d930c9edce0238d3c7c3dcda8 Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Wed, 20 Mar 2024 14:26:41 +0000 Subject: [PATCH 2/6] editcreds --- .../ecosystem-authentication copy.md | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 src/markdown-pages/docs/ecosystem/ecosystem-authentication copy.md diff --git a/src/markdown-pages/docs/ecosystem/ecosystem-authentication copy.md b/src/markdown-pages/docs/ecosystem/ecosystem-authentication copy.md new file mode 100644 index 00000000..e3db23bb --- /dev/null +++ b/src/markdown-pages/docs/ecosystem/ecosystem-authentication copy.md @@ -0,0 +1,33 @@ +--- +path: "/docs/ecosystem/ecosystem-authentication" +title: "Configuring authentication" +--- + +Before interacting with a Galasa Ecosystem using the Galasa command line tool (galasactl), you must be authenticated with it. Galasa uses personal access tokens to authenticate users who want to interact with a Galasa Ecosystem provided by the `GALASA_BOOTSTRAP` environment variable or through the `--bootstrap` flag. + + +Personal access tokens are stored in the `GALASA_TOKEN` property in the `galasactl.properties` file in your Galasa home folder. The `galasactl.properties` file is created when you run the `galasa local init` command. Setting the `GALASA_TOKEN` property in this file with a valid token value allows the galasactl tool to access and communicate with an Ecosystem on behalf of the user. + + +If you have [installed your Galasa Ecosystem](../ecosystem/ecosystem-installing-k8s) by using the Galasa Ecosystem Helm chart that is provided with Galasa, you will have access to the Galasa Web UI. To get a value for the `GALASA_TOKEN` property, log into the Galasa Web UI and request a personal access token which can be copied into the `GALASA_TOKEN` property. The instructions on how to do this are displayed in a dialog box in the Galasa Web UI. You can choose to set the token as an environmental variable but the value would not persist across terminals, so is only valid for that session. + +## Authentication architecture + +The following diagram shows the architecture for the authentication process: + +![Galasa ecosystem architecture:](ecosystem-cluster-auth.svg) + + +When a user logs into the Galasa Web UI via their browser, the Web UI contacts the Galasa API server which in turn talks to a Dex server, providing it with the user ID. The Dex server talks to an identity provider, for example GitHub or LDAP, to authenticate that user. If the user is successfully authenticated, the provider returns an access token to the Dex server which sends that token to Galasa API server. The token is then sent to the Galasa Web UI where it is visible to the user. The user can then configure that token into the galasactl command line tool by updating the `GALASA_TOKEN` property in the `galasactl.properties` file. The user can then be authenticated each time the galasactl tool is used to log into a Galasa Ecosystem. + +On a successful login, a `bearer-token.json` file is created in the Galasa home directory. This file contains a bearer token that galasactl uses to authenticate requests when communicating with a Galasa Ecosystem. If the bearer token expires, galasactl automatically attempts to re-authenticate with the Galasa Ecosystem using the properties in the `galasactl.properties` file within the Galasa home directory. + +### Logging in to a Galasa Ecosystem using the auth login command + +You can log in to a Galasa Ecosystem explicitly by using the `galasactl auth login` command. You might want to do an explicit log in if you are running galasactl as part of a build pipeline, or if you just want to make sure you can log in. + + +### Logging out of a Galasa Ecosystem using the auth logout command + +To log out of a Galasa Ecosystem using galasactl, you can use the `galasactl auth logout` command. If you run a galasactl command that interacts with an Ecosystem while logged out, galasactl will attempt to automatically log in using the properties in your `galasactl.properties` file within your Galasa home directory. + From 38825f2f017f8f3acd60314f38f4994b341ac3c7 Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Thu, 21 Mar 2024 09:38:13 +0000 Subject: [PATCH 3/6] update managers for cics region --- .../docs/managers/cics-ts-manager.md | 44 +++++++++++++--- .../docs/managers/zos-manager.md | 51 +++++++++++++++++-- 2 files changed, 85 insertions(+), 10 deletions(-) diff --git a/src/markdown-pages/docs/managers/cics-ts-manager.md b/src/markdown-pages/docs/managers/cics-ts-manager.md index 66a6fdb5..4c9c6a54 100644 --- a/src/markdown-pages/docs/managers/cics-ts-manager.md +++ b/src/markdown-pages/docs/managers/cics-ts-manager.md @@ -14,13 +14,43 @@ This Manager is at Alpha level. You can view the Overview -This Manager provides Galasa tests to CICS/TS functions.

+This Manager provides Galasa tests to CICS/TS functions. + ## Configuration Properties -The following are properties used to configure the CICS TS Manager. +The following are properties that are used to configure the CICS TS Manager in the CPS. + +To provision a DSE?CICS Region for your test, as a minimum you need to configure the following properties for the CICS TS Manager: + +``` +cicsts.provision.type=dse +cicsts.dse.tag.[TAG].applid=[APPLID] +``` + +You also need to configure the following properties for the [z/OS Manager](zos-manager) as a minimum to connect to a CICS region, even if you do not reference a `@ZosImage` in your Galasa test. This is because ?? (as it's the z/OS image the CICS Region is on...). You might need to configure additional z/OS-related CPS properties, depending on your test. + +``` +zos.dse.tag.PRIMARY.imageid=[IMAGEID] OR zos.cluster.DEFAULT.images=[IMAGEID] +zos.image.[IMAGEID].ipv4.hostname=[IP ADDRESS] +zos.image.[IMAGEID].credentials=[CREDENTIALID] +``` + +
+Developer Supplied Environment - CICS TS Region - Type + +| Property: | Developer Supplied Environment - CICS TS Region - Type | +| --------------------------------------- | :------------------------------------- | +| Name: | cicsts.provision.type | +| Description: | Provides the type of the CICS TS region for the DSE provisioner. The type setting is mandatory for a DSE region. | +| Required: | Yes if you want a DSE region, otherwise not required. You must set this property if you are using the cicsts.dse.tag.[TAG].applid property. | +| Default value: | None | +| Valid values: | dse| +| Examples: | <cicsts.provision.type=dse
| + +
Developer Supplied Environment - CICS TS Region - Applid @@ -28,11 +58,11 @@ The following are properties used to configure the CICS TS Manager. | Property: | Developer Supplied Environment - CICS TS Region - Applid | | --------------------------------------- | :------------------------------------- | | Name: | cicsts.dse.tag.[TAG].applid | -| Description: | Provides the applid of the CICS TS region for the DSE provisioner. The applid setting is mandatory for a DSE region. | -| Required: | Yes if you want a DSE region, otherwide not required | +| Description: | Provides the applid of the CICS TS region for the DSE provisioner. The applid setting is mandatory for a DSE region. If you are using this property, you must also set the cicsts.provision.type property to specify the CICS TS Region type to be `dse`. For example, cicsts.provision.type=dse.| +| Required: | Yes if you want a DSE region, otherwise not required. | | Default value: | None | | Valid values: | A value VTAM applid | -| Examples: | cicsts.dse.tag.PRIMARY.applid=CICS1A
| +| Examples: | cicsts.dse.tag.PRIMARY.applid=CICS1A
|
@@ -56,9 +86,9 @@ The following are properties used to configure the CICS TS Manager. | Property: | Extra bundles required to implement the CICS TS Manager | | --------------------------------------- | :------------------------------------- | | Name: | cicsts.extra.bundles | -| Description: | The symbolic names of any bundles that need to be loaded with the CICS TS Manager | +| Description: | The symbolic names of any bundles that need to be loaded
with the CICS TS Manager. | | Required: | No | -| Default value: | dev.galasa.cicsts.ceci.manager,dev.galasa.cicsts.ceda.manager,dev.galasa.cicsts.cemt.manager | +| Default value: | dev.galasa.cicsts.ceci.manager,dev.galasa.cicsts.ceda.manager,
dev.galasa.cicsts.cemt.manager | | Valid values: | bundle symbolic names comma separated | | Examples: | cicsts.extra.bundles=org.example.cicsts.provisioning
| diff --git a/src/markdown-pages/docs/managers/zos-manager.md b/src/markdown-pages/docs/managers/zos-manager.md index 196c5383..82ac47bb 100644 --- a/src/markdown-pages/docs/managers/zos-manager.md +++ b/src/markdown-pages/docs/managers/zos-manager.md @@ -60,7 +60,52 @@ compileOnly 'dev.galasa:dev.galasa.zos.manager' # Configuring The following properties are used to configure the z/OS Manager. - + + +To provision a DSE?CICS Region for your test you need to configure the following properties as a minimum to connect to a CICS region, even if you do not reference a `@ZosImage` in your Galasa test. This is because ?? (as it's the z/OS image the CICS Region is on...). You might need to configure additional z/OS-related CPS properties, depending on your test. + +``` +zos.dse.tag.PRIMARY.imageid=[IMAGEID] OR zos.cluster.DEFAULT.images=[IMAGEID] +zos.image.[IMAGEID].ipv4.hostname=[IP ADDRESS] +zos.image.[IMAGEID].credentials=[CREDENTIALID] +``` + +You also need to configure the following properties for the [CICS TS Manager](cics-ts-manager): + +``` +cicsts.provision.type=dse +cicsts.dse.tag.[TAG].applid=[APPLID] +``` + +
+xxxx + +| Property: | Extra bundle required to implement the zOS Batch Manager | +| --------------------------------------- | :------------------------------------- | +| Name: | zos.image.[IMAGEID].ipv4.hostname=[IPADDRESS] | +| 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 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
| + +
+ +
+xxxx + +| Property: | Extra bundle required to implement the zOS Batch Manager | +| --------------------------------------- | :------------------------------------- | +| Name: | zos.image.[IMAGEID].credentials=[CREDENTIALID] | +| 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 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
| + +
+ +
Extra bundle required to implement the z/OS Batch Manager @@ -80,7 +125,7 @@ The following properties are used to configure the z/OS Manager. | Property: | The zOS Cluster ID | | --------------------------------------- | :------------------------------------- | -| Name: | zos.tag.[tag].clusterid | +| Name: | zos.tag.[tag].clusterid | | Description: | The z/OS Cluster ID for the specified tag | | Required: | No | | Default value: | None | @@ -94,7 +139,7 @@ The following properties are used to configure the z/OS Manager. | Property: | The images for a zOS Cluster | | --------------------------------------- | :------------------------------------- | -| Name: | zos.cluster.[clusterId].images | +| Name: | zos.cluster.[clusterId].images | | Description: | The z/OS Images for the specified cluster. Specify more than one image by using commas. | | Required: | No | | Default value: | None | From 29e683c557f0bec7f23624342c4295538c90614e Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Fri, 22 Mar 2024 13:47:11 +0000 Subject: [PATCH 4/6] update secrets --- src/data/nav.yaml | 2 + .../ecosystem-authentication copy.md | 33 ---- .../docs/ecosystem/ecosystem-update-creds.md | 151 ++++++++++++++++++ 3 files changed, 153 insertions(+), 33 deletions(-) delete mode 100644 src/markdown-pages/docs/ecosystem/ecosystem-authentication copy.md create mode 100644 src/markdown-pages/docs/ecosystem/ecosystem-update-creds.md diff --git a/src/data/nav.yaml b/src/data/nav.yaml index 7d570037..ab80c6eb 100644 --- a/src/data/nav.yaml +++ b/src/data/nav.yaml @@ -112,6 +112,8 @@ path: /docs/cli-command-reference/cli-runs-get - title: Downloading test artifacts path: /docs/cli-command-reference/ecosystem-cli-runs-download + - title: Updating credentials in an Ecosystem + path: /docs/ecosystem/ecosystem-update-creds - title: Upgrading path: /docs/upgrading - title: Managers diff --git a/src/markdown-pages/docs/ecosystem/ecosystem-authentication copy.md b/src/markdown-pages/docs/ecosystem/ecosystem-authentication copy.md deleted file mode 100644 index e3db23bb..00000000 --- a/src/markdown-pages/docs/ecosystem/ecosystem-authentication copy.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -path: "/docs/ecosystem/ecosystem-authentication" -title: "Configuring authentication" ---- - -Before interacting with a Galasa Ecosystem using the Galasa command line tool (galasactl), you must be authenticated with it. Galasa uses personal access tokens to authenticate users who want to interact with a Galasa Ecosystem provided by the `GALASA_BOOTSTRAP` environment variable or through the `--bootstrap` flag. - - -Personal access tokens are stored in the `GALASA_TOKEN` property in the `galasactl.properties` file in your Galasa home folder. The `galasactl.properties` file is created when you run the `galasa local init` command. Setting the `GALASA_TOKEN` property in this file with a valid token value allows the galasactl tool to access and communicate with an Ecosystem on behalf of the user. - - -If you have [installed your Galasa Ecosystem](../ecosystem/ecosystem-installing-k8s) by using the Galasa Ecosystem Helm chart that is provided with Galasa, you will have access to the Galasa Web UI. To get a value for the `GALASA_TOKEN` property, log into the Galasa Web UI and request a personal access token which can be copied into the `GALASA_TOKEN` property. The instructions on how to do this are displayed in a dialog box in the Galasa Web UI. You can choose to set the token as an environmental variable but the value would not persist across terminals, so is only valid for that session. - -## Authentication architecture - -The following diagram shows the architecture for the authentication process: - -![Galasa ecosystem architecture:](ecosystem-cluster-auth.svg) - - -When a user logs into the Galasa Web UI via their browser, the Web UI contacts the Galasa API server which in turn talks to a Dex server, providing it with the user ID. The Dex server talks to an identity provider, for example GitHub or LDAP, to authenticate that user. If the user is successfully authenticated, the provider returns an access token to the Dex server which sends that token to Galasa API server. The token is then sent to the Galasa Web UI where it is visible to the user. The user can then configure that token into the galasactl command line tool by updating the `GALASA_TOKEN` property in the `galasactl.properties` file. The user can then be authenticated each time the galasactl tool is used to log into a Galasa Ecosystem. - -On a successful login, a `bearer-token.json` file is created in the Galasa home directory. This file contains a bearer token that galasactl uses to authenticate requests when communicating with a Galasa Ecosystem. If the bearer token expires, galasactl automatically attempts to re-authenticate with the Galasa Ecosystem using the properties in the `galasactl.properties` file within the Galasa home directory. - -### Logging in to a Galasa Ecosystem using the auth login command - -You can log in to a Galasa Ecosystem explicitly by using the `galasactl auth login` command. You might want to do an explicit log in if you are running galasactl as part of a build pipeline, or if you just want to make sure you can log in. - - -### Logging out of a Galasa Ecosystem using the auth logout command - -To log out of a Galasa Ecosystem using galasactl, you can use the `galasactl auth logout` command. If you run a galasactl command that interacts with an Ecosystem while logged out, galasactl will attempt to automatically log in using the properties in your `galasactl.properties` file within your Galasa home directory. - diff --git a/src/markdown-pages/docs/ecosystem/ecosystem-update-creds.md b/src/markdown-pages/docs/ecosystem/ecosystem-update-creds.md new file mode 100644 index 00000000..a185ca4d --- /dev/null +++ b/src/markdown-pages/docs/ecosystem/ecosystem-update-creds.md @@ -0,0 +1,151 @@ +--- +path: "/docs/ecosystem/ecosystem-update-creds" +title: "Updating credentials in an Ecosystem" +--- + +It is likely that a test will need to pass credentials to the application being tested. For example, as HTTP credentials or as username and password values entered onto a 3270 screen. In a Galasa Ecosystem the credentials store (CREDS), which is hosted in the etcd server, securely provides the credentials (for example, password, username, and personal access token) that are required for a test to run in automation. + +You can set a username, password, or token in the CREDS by using a Visual Studio Code (VS Code) Kubernetes extension or by using the command line. The ability to set these properties means that you can supply test cases with the credentials and tokens that they need to run. To set these credentials you must have permission to access the CREDS pod on a Galasa Ecosystem. You can then use the etcdctl tool to manipulate the etcd server values in a [namespace](../ecosystem/ecosystem-manage-cps). + +The following examples show how you can update the CREDS. In these examples, the CREDS pod is called `creds` and the namespace is `galasa-ecosystem`. + + +## Logging into the CREDS pod by using the VSCode Kubernetes extension + +Complete the following steps to log into the CREDS pod using the VS Code Kubernetes extension. + +1. In the VSCode Kubernetes extension, confirm that the tool is pointing at the Kubernetes cluster that hosts your Galasa Ecosystem. If it is not, you can select the cluster by navigating to `Clusters`, right-clicking the cluster you need, and selecting `Set as Current Cluster`. +2. Set your namespace to `galasa-ecosystem` by navigating to `Namespaces`, right-clicking the namespace and selecting `Use Namespace`. +3. Go to your Pods by navigating to `Workloads`>`Pods`. +4. Exec on to the `creds` pod by right-clicking the pod and selecting `Terminal`, or by selecting the `Terminal` icon. A shell of the `creds` pod opens in VSCode. + + +## Logging into the CREDS pod by using the command line + +1. Open a terminal and on the command line, exec into your `creds` pod: +``` +kubectl exec -it creds -n galasa-ecosystem -- /bin/sh +``` + + +## Configuring credentials in the CREDS pod + +Once you are shelled into your `creds` pod you can configure credentials by using the `etcdctl` command line tool to interact with the etcd server. + +First, set the `etcd` version by running the following command: +``` +export ETCDCTL_API=3 +``` + +You can then use the following `etcdctl` commands in your CREDS pod to help you to configure your credentials. + + +### Retrieve all credentials + +To retrieve all credentials, run the following command: +``` +etcdctl get --prefix "" +``` + +### Retrieve all credentials with a specified prefix + +To retrieve all credentials with a specified prefix, use the following example command: +``` +etcdctl get --prefix "{myprefix}" +``` +where `{myprefix}` is the value that you want the returned credentials to start with. + +For example, to view all credentials that start with `secure.credentials.SIMBANK`, run the following command: +``` +etcdctl get --prefix "secure.credentials.SIMBANK" +``` +The following example shows the returned credentials: +``` +/ # etcdctl get --prefix "secure.credentials.SIMBANK" +secure.credentials.SIMBANK.password +SYS1 +secure.credentials.SIMBANK.username +IBMUSER +``` + +### Retrieve a specific credential + +To retrieve a specific credential, use the following example command: +``` +etcdctl get {key} +``` +where `{key}` is the name of the credential that you want returned + +For example, to retrieve the credential `secure.credentials.SIMBANK.username`, run the following command: + +``` +etcdctl get --prefix "secure.credentials.SIMBANK.username" +``` + +The following example shows the returned credential: + +``` +/ # etcdctl get secure.credentials.SIMBANK.username +secure.credentials.SIMBANK.username +IBMUSER +``` + +### Create or update a credential + +To retrieve a specific credential, use the following example command: + +``` +etcdctl put {key} {value} +``` + +where:
+`{key}` is the name of the credential that you want to update and
+`{value}` is the value that you want to give to that credential + +For example, to update the credential `secure.credentials.SIMBANK.username` with a value of `NEWUSER`, run the following command: + +``` +etcdctl put secure.credentials.SIMBANK.username NEWUSER +``` + +The following example shows a successful response: +``` +/ # etcdctl put secure.credentials.SIMBANK.username NEWUSER +OK +``` + + +### Delete a credential + +To delete a specific credential, use the following example command: + +``` +etcdctl del {key} +``` + +where: +`{key}` is the name of the credential that you want to delete + + +For example, to delete the credential `secure.credentials.SIMBANK.username`, run the following command: + +``` +etcdctl del secure.credentials.SIMBANK.username +``` + +The following example shows a successful response: +``` +/ # etcdctl del secure.credentials.SIMBANK.username +1 +``` + +If the credential does not exist, a value of `0` rather than `1` is returned in the response. + +### Exit the shell + +To exit the shell, simply run: +``` +exit +``` + +Updated credentials are now available for a test to run in automation on a Galasa Ecosystem. \ No newline at end of file From f88139e197e5f5ca8e7f2a339adeaf91b310ab3a Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Mon, 25 Mar 2024 12:57:37 +0000 Subject: [PATCH 5/6] add new properties --- .../docs/managers/cics-ts-manager.md | 6 ++-- .../docs/managers/zos-manager.md | 36 +++++++++---------- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/src/markdown-pages/docs/managers/cics-ts-manager.md b/src/markdown-pages/docs/managers/cics-ts-manager.md index 4c9c6a54..fdbb9ab5 100644 --- a/src/markdown-pages/docs/managers/cics-ts-manager.md +++ b/src/markdown-pages/docs/managers/cics-ts-manager.md @@ -23,17 +23,17 @@ This Manager provides Galasa tests to CICS/TS functions. The following are properties that are used to configure the CICS TS Manager in the CPS. -To provision a DSE?CICS Region for your test, as a minimum you need to configure the following properties for the CICS TS Manager: +To provision a CICS Region for your test, as a minimum you need to configure the following properties for the CICS TS Manager: ``` cicsts.provision.type=dse cicsts.dse.tag.[TAG].applid=[APPLID] ``` -You also need to configure the following properties for the [z/OS Manager](zos-manager) as a minimum to connect to a CICS region, even if you do not reference a `@ZosImage` in your Galasa test. This is because ?? (as it's the z/OS image the CICS Region is on...). You might need to configure additional z/OS-related CPS properties, depending on your test. +You also need to configure the following properties for the [z/OS Manager](zos-manager) as a minimum to connect to a CICS region, even if you do not reference a `@ZosImage` in your Galasa test. This is because CICS Regions sit on a z/OS LPAR, and so to provision and connect to a CICS Region in a test, you also need access to the z/OS image that it sits within to make requests on the CICS Region. You might need to configure additional z/OS-related CPS properties, depending on your test. ``` -zos.dse.tag.PRIMARY.imageid=[IMAGEID] OR zos.cluster.DEFAULT.images=[IMAGEID] +zos.dse.tag.PRIMARY.imageid=[IMAGEID] OR zos.cluster.[clusterId].images=[IMAGEID] zos.image.[IMAGEID].ipv4.hostname=[IP ADDRESS] zos.image.[IMAGEID].credentials=[CREDENTIALID] ``` diff --git a/src/markdown-pages/docs/managers/zos-manager.md b/src/markdown-pages/docs/managers/zos-manager.md index 82ac47bb..b4db4e7e 100644 --- a/src/markdown-pages/docs/managers/zos-manager.md +++ b/src/markdown-pages/docs/managers/zos-manager.md @@ -61,11 +61,11 @@ compileOnly 'dev.galasa:dev.galasa.zos.manager' The following properties are used to configure the z/OS Manager. +To provision a CICS Region for your test you need to configure the following properties as a minimum to connect to a CICS region, even if you do not reference a `@ZosImage` in your Galasa test. This is because CICS Regions sit on a z/OS LPAR, and so to provision and connect to a CICS Region in a test, you also need access to the z/OS image that it sits within to make requests on the CICS Region. You might need to configure additional z/OS-related CPS properties, depending on your test. -To provision a DSE?CICS Region for your test you need to configure the following properties as a minimum to connect to a CICS region, even if you do not reference a `@ZosImage` in your Galasa test. This is because ?? (as it's the z/OS image the CICS Region is on...). You might need to configure additional z/OS-related CPS properties, depending on your test. ``` -zos.dse.tag.PRIMARY.imageid=[IMAGEID] OR zos.cluster.DEFAULT.images=[IMAGEID] +zos.dse.tag.[tag].imageid=[IMAGEID] OR zos.cluster.[clusterId].images=[IMAGEID] zos.image.[IMAGEID].ipv4.hostname=[IP ADDRESS] zos.image.[IMAGEID].credentials=[CREDENTIALID] ``` @@ -78,30 +78,30 @@ cicsts.dse.tag.[TAG].applid=[APPLID] ```
-xxxx +Hostname of a z/OS system -| Property: | Extra bundle required to implement the zOS Batch Manager | +| Property: | Hostname of a z/OS system | | --------------------------------------- | :------------------------------------- | -| Name: | zos.image.[IMAGEID].ipv4.hostname=[IPADDRESS] | -| 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 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
| +| Name: | zos.image.[IMAGEID].ipv4.hostname | +| Description: | A physical TCP/IP hostname value for a z/OS system | +| Required: | Yes, if connecting to a CICS region | +| Default value: | None | +| Valid values: | A valid TCP/IP hostname | +| Examples: | zos.image.IMAGEA.ipv4.hostname=dev.galasa.system1
zos.image.SIMBANK.ipv4.hostname=127.0.0.1
zos.image.IMAGEA.ipv4.hostname=winmvs2a.example.com
|
-xxxx +Credentials for logging onto a z/OS system -| Property: | Extra bundle required to implement the zOS Batch Manager | +| Property: | Credentials for logging onto a z/OS system | | --------------------------------------- | :------------------------------------- | -| Name: | zos.image.[IMAGEID].credentials=[CREDENTIALID] | -| 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 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
| +| Name: | zos.image.[IMAGEID].credentials | +| Description: | Credentials for logging onto a z/OS system | +| Required: | Yes, if connecting to a CICS region | +| Default value: | None| +| Valid values: | Valid characters are A-Z, a - z, 0-9 | +| Examples: | zos.image.IMAGEA.credentials=KEY_TO_CREDS_STORE
zos.image.SIMBANK.credentials=SIMBANK
zos.image.IMAGEA.credentials=WINMVS2A
|
From 3f8d7e9f1fa671c627c3162611c0301ee1e89883 Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Tue, 26 Mar 2024 08:48:21 +0000 Subject: [PATCH 6/6] review updates --- .../docs/managers/cics-ts-manager.md | 18 ++++++++------- .../docs/managers/zos-manager.md | 22 +++++++++++-------- 2 files changed, 23 insertions(+), 17 deletions(-) diff --git a/src/markdown-pages/docs/managers/cics-ts-manager.md b/src/markdown-pages/docs/managers/cics-ts-manager.md index fdbb9ab5..ebafcac5 100644 --- a/src/markdown-pages/docs/managers/cics-ts-manager.md +++ b/src/markdown-pages/docs/managers/cics-ts-manager.md @@ -16,21 +16,17 @@ This Manager is at Alpha level. You can view the Configuration Properties - -The following are properties that are used to configure the CICS TS Manager in the CPS. - -To provision a CICS Region for your test, as a minimum you need to configure the following properties for the CICS TS Manager: - ``` cicsts.provision.type=dse cicsts.dse.tag.[TAG].applid=[APPLID] ``` -You also need to configure the following properties for the [z/OS Manager](zos-manager) as a minimum to connect to a CICS region, even if you do not reference a `@ZosImage` in your Galasa test. This is because CICS Regions sit on a z/OS LPAR, and so to provision and connect to a CICS Region in a test, you also need access to the z/OS image that it sits within to make requests on the CICS Region. You might need to configure additional z/OS-related CPS properties, depending on your test. +You also need to configure the following properties for the [z/OS Manager](zos-manager) as a minimum to connect to a CICS region, even if you do not reference a `@ZosImage` in your Galasa test. This is because CICS regions sit on a z/OS LPAR, and so to provision and connect to a CICS region in a test, you also need access to the z/OS image that it sits within to make requests on the CICS region. You might need to configure additional z/OS-related CPS properties, depending on your test. ``` zos.dse.tag.PRIMARY.imageid=[IMAGEID] OR zos.cluster.[clusterId].images=[IMAGEID] @@ -38,6 +34,12 @@ zos.image.[IMAGEID].ipv4.hostname=[IP ADDRESS] zos.image.[IMAGEID].credentials=[CREDENTIALID] ``` + +## Configuration Properties + +The following are properties that are used to configure the CICS TS Manager in the CPS. + +
Developer Supplied Environment - CICS TS Region - Type @@ -58,7 +60,7 @@ zos.image.[IMAGEID].credentials=[CREDENTIALID] | Property: | Developer Supplied Environment - CICS TS Region - Applid | | --------------------------------------- | :------------------------------------- | | Name: | cicsts.dse.tag.[TAG].applid | -| Description: | Provides the applid of the CICS TS region for the DSE provisioner. The applid setting is mandatory for a DSE region. If you are using this property, you must also set the cicsts.provision.type property to specify the CICS TS Region type to be `dse`. For example, cicsts.provision.type=dse.| +| Description: | Provides the applid of the CICS TS region for the DSE provisioner. The applid setting is mandatory for a DSE region. If you are using this property, you must also set the cicsts.provision.type property to specify the CICS TS region type to be `dse`. For example, cicsts.provision.type=dse.| | Required: | Yes if you want a DSE region, otherwise not required. | | Default value: | None | | Valid values: | A value VTAM applid | diff --git a/src/markdown-pages/docs/managers/zos-manager.md b/src/markdown-pages/docs/managers/zos-manager.md index b4db4e7e..cfc15b2b 100644 --- a/src/markdown-pages/docs/managers/zos-manager.md +++ b/src/markdown-pages/docs/managers/zos-manager.md @@ -57,11 +57,9 @@ compileOnly 'dev.galasa:dev.galasa.zos.manager' } ``` -# Configuring - -The following properties are used to configure the z/OS Manager. +## Testing CICS Regions on z/OS -To provision a CICS Region for your test you need to configure the following properties as a minimum to connect to a CICS region, even if you do not reference a `@ZosImage` in your Galasa test. This is because CICS Regions sit on a z/OS LPAR, and so to provision and connect to a CICS Region in a test, you also need access to the z/OS image that it sits within to make requests on the CICS Region. You might need to configure additional z/OS-related CPS properties, depending on your test. +To connect your Galasa test to a developer supplied environment with a provisioned CICS region as a minimum you need to configure the following properties, even if you do not reference a `@ZosImage` in your Galasa test. This is because CICS regions sit on a z/OS LPAR, and so to provision and connect to a CICS region in a test, you also need access to the z/OS image that it sits within to make requests on the CICS region. You might need to configure additional z/OS-related CPS properties, depending on your test. ``` @@ -77,6 +75,12 @@ cicsts.provision.type=dse cicsts.dse.tag.[TAG].applid=[APPLID] ``` + +# Configuring + +The following properties are used to configure the z/OS Manager. + +
Hostname of a z/OS system @@ -84,7 +88,7 @@ cicsts.dse.tag.[TAG].applid=[APPLID] | --------------------------------------- | :------------------------------------- | | Name: | zos.image.[IMAGEID].ipv4.hostname | | Description: | A physical TCP/IP hostname value for a z/OS system | -| Required: | Yes, if connecting to a CICS region | +| Required: | Yes, if connecting to a z/OS image | | Default value: | None | | Valid values: | A valid TCP/IP hostname | | Examples: | zos.image.IMAGEA.ipv4.hostname=dev.galasa.system1
zos.image.SIMBANK.ipv4.hostname=127.0.0.1
zos.image.IMAGEA.ipv4.hostname=winmvs2a.example.com
| @@ -92,13 +96,13 @@ cicsts.dse.tag.[TAG].applid=[APPLID]
-Credentials for logging onto a z/OS system +Credentials tag for logging onto a z/OS system -| Property: | Credentials for logging onto a z/OS system | +| Property: | Credentials tag for logging onto a z/OS system | | --------------------------------------- | :------------------------------------- | | Name: | zos.image.[IMAGEID].credentials | -| Description: | Credentials for logging onto a z/OS system | -| Required: | Yes, if connecting to a CICS region | +| Description: | Tag of the credentials that are stored in the CREDS and used to log onto a z/OS system | +| Required: | Yes, if connecting to a z/OS image | | Default value: | None| | Valid values: | Valid characters are A-Z, a - z, 0-9 | | Examples: | zos.image.IMAGEA.credentials=KEY_TO_CREDS_STORE
zos.image.SIMBANK.credentials=SIMBANK
zos.image.IMAGEA.credentials=WINMVS2A
|