Skip to content

Commit

Permalink
Merge pull request #755 from galasa-dev/next
Browse files Browse the repository at this point in the history
publish installing an ecosystem using helm and faqs
  • Loading branch information
CaroMac authored Feb 8, 2024
2 parents 2b8f5ec + 999246d commit 3d789cb
Show file tree
Hide file tree
Showing 13 changed files with 620 additions and 187 deletions.
10 changes: 6 additions & 4 deletions src/data/nav.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -103,17 +103,17 @@
items:
- title: Ecosystem architecture
path: /docs/ecosystem/architecture
- title: Installing the Ecosystem on Kubernetes
- title: Installing an Ecosystem using Helm
path: /docs/ecosystem/installing/k8s
- title: Test streams
path: /docs/writing-own-tests/test-streams
- title: Managing integrated test runs
path: /docs/ecosystem/ecosystem-manage-cps
- title: Configuring the Ecosystem using resource files
- title: Configuring an Ecosystem using resource files
path: /docs/ecosystem/cps-yaml
- title: Selecting tests to run in the Ecosystem
- title: Selecting tests to run in an Ecosystem
path: /docs/cli-command-reference/ecosystem-cli-runs-prepare
- title: Running tests in the Ecosystem
- title: Running tests in an Ecosystem
path: /docs/cli-command-reference/ecosystem-cli-runs-submit
- title: Viewing test run results
path: /docs/cli-command-reference/cli-runs-get
Expand Down Expand Up @@ -144,6 +144,8 @@
path: /docs/manager-groups/workflow-manager-group
- title: z/OS Managers
path: /docs/manager-groups/zos-manager-group
- title: FAQs
path: /docs/faqs-galasa/
- title: Reference
path: /docs/reference/
items:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,4 +125,4 @@ galasactl runs submit local --debug

Read the [Viewing test results locally](viewing-test-results-cli) documentation to learn how to view the output of your test runs in your local environment.

Take a look at the [Exploring Galasa SimBank using the CLI](simbank-cli) documentation. Galasa SimBank is a component that is distributed with Galasa. SimBank simulates a mainframe application and is designed to help you to learn Galasa's basic principles of operation before you start connecting Galasa to your own mainframe application-under-test.
Take a look at the [Exploring Galasa SimBank using the CLI](simbank-cli) documentation. Galasa SimBank is a component that is distributed with Galasa. SimBank simulates a mainframe application and is designed to help you to learn the basic principles of Galasa's operation before you start connecting Galasa to your own mainframe application-under-test.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
path: "/docs/cli-command-reference/ecosystem-cli-runs-prepare"
title: "Selecting tests to run in the Ecosystem"
title: "Selecting tests to run in an Ecosystem"
---

If you have a group of tests that you want to run in batch, the simplest way to do this is by defining these tests inside a portfolio. You can create a portfolio of tests by using the `runs prepare` command. You can build the portfolio from single or multiple [test streams](https://galasa.dev/docs/writing-own-tests/test-streams).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
path: "/docs/cli-command-reference/ecosystem-cli-runs-submit"
title: "Running tests in the Ecosystem"
title: "Running tests in an Ecosystem"
---

The `runs submit` command submits and monitors tests in the Galasa Ecosystem. Tests can be input either from a portfolio or directly from a test package.
Expand Down
10 changes: 5 additions & 5 deletions src/markdown-pages/docs/ecosystem/ecosystem-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ path: "/docs/ecosystem/architecture"
title: "Ecosystem Architecture"
---

The following diagram provides a high-level representation of the Galasa Ecosystem architecture:<br><br> ![Galasa ecosystem architecture:](ecosystem-overview.svg)
The following diagram provides a high-level representation of the Galasa Ecosystem architecture:<br><br> ![Galasa ecosystem architecture:](ecosystem-overview-new.svg)

<br>The ecosystem is made up of a collection of microservices for orchestrating runtimes, monitoring tests and resources, and providing clean-up of those resources if required. The ecosystem provides a centralized store for run configurations, a single location for storing all test results and test artifacts, and utilizes a REST endpoint that can be called from any IDE or pipeline.
<br>The Ecosystem is made up of a collection of microservices for orchestrating runtimes, monitoring tests and resources, and providing clean-up of those resources if required. The Ecosystem provides a centralized store for run configurations, a single location for storing all test results and test artifacts, and utilizes a REST endpoint that can be called from any IDE or pipeline.


### Key components:

The following diagram highlights a some of the key components that make up the Galasa Ecosystem and examples of external resources with which Galasa can interact: ![Galasa ecosystem:](galasa-ecosystem-architecture.svg)
The following diagram highlights a some of the key components that make up the Galasa Ecosystem and examples of external resources with which Galasa can interact: ![Galasa ecosystem:](galasa-ecosystem-architecture-new.svg)

<br>Expand the following sections to find out more about the key components of the Galasa Ecosystem:

Expand Down Expand Up @@ -40,8 +40,8 @@ The following diagram highlights a some of the key components that make up the G
| **Metrics Server** | The metrics server indicates the health of the ecosystem, for example, providing metrics on the number of successful test runs. |
| **API Server** | The API server acts as a central point from which to control the Galasa Ecosystem and is used by Galasa as an endpoint with which IDEs and pipelines interact for submitting tests and retrieving results. The API server hosts the bootstrap server. |
| **Bootstrap Server** | The bootstrap server is part of the API server. The bootstrap is an endpoint that is provided by the API server to store the initial configuration required to instantiate a Galasa framework. When setting up the Galasa Ecosystem, the Eclipse IDE must be updated to point to the bootstrap that is configured to use the ecosystem. |
| **Web UI** | The WebUI is currently under construction and planned for a future release. Use the WebUI to see a dashboard overview of the current and historical health of the Galasa framework. The UI can also run, schedule or reschedule tests, be used to analyse output from failed test runs, and manage the configuration needed to customise the framework and tests for maximum throughput, resilience and flexibility. |
| **LDAP authentication server (Optional)** | This server is planned for a future release to provide the ability to authenticate through an LDAP server. |
| **Galasa Web UI** | The Galasa Web UI is currently under construction and planned for a future release. Use the WebUI to see a dashboard overview of the current and historical health of the Galasa framework. The UI can also run, schedule or reschedule tests, be used to analyse output from failed test runs, and manage the configuration needed to customise the framework and tests for maximum throughput, resilience and flexibility. |
| **Dex** | The Galasa Ecosystem Helm chart's use of Dex is under development and is subject to change. In a future release, Dex will be used to authenticate users interacting with a Galasa Ecosystem. |

</details>

Expand Down
Loading

0 comments on commit 3d789cb

Please sign in to comment.