Skip to content
This repository was archived by the owner on Nov 5, 2024. It is now read-only.

Commit 87c532e

Browse files
authored
Merge pull request #187 from Chr1st1anSears/new-environments-doc
New envs section with new overview doc
2 parents ecb40b3 + 75f475c commit 87c532e

File tree

4 files changed

+31
-2
lines changed

4 files changed

+31
-2
lines changed

docs/modules/ROOT/nav-how-to-guides.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@
1111
*** xref:how-to-guides/testing_applications/surface-level_tests.adoc[Surface-level tests]
1212
*** xref:how-to-guides/testing_applications/proc_adding_an_integration_test.adoc[Adding an integration test]
1313
*** xref:how-to-guides/testing_applications/proc_creating_custom_test.adoc[Creating a custom integration test]
14+
** Managing environments
15+
*** xref:how-to-guides/managing-environments/con_overview_of_environments.adoc[Overview of {ProductName} environments]
16+
*** xref:how-to-guides//managing-environments/proc_creating_your_own_environment.adoc[Creating your own environment]
1417
** Securing your supply chain
1518
*** xref:how-to-guides/Secure-your-supply-chain/proc_inspect_sbom.adoc[Inspecting SBOMs]
1619
*** xref:how-to-guides/Secure-your-supply-chain/proc_inspect-slsa-provenance.adoc[Downloading your SLSA provenance]
1720
*** xref:how-to-guides/Secure-your-supply-chain/proc_java_dependencies.adoc[Configuring dependencies rebuild for Java apps in the CLI]
18-
** xref:how-to-guides/proc_creating_your_own_environment.adoc[Creating your own environment]
1921
** xref:how-to-guides/proc_managing-compliance-with-the-enterprise-contract.adoc[Managing compliance with the Enterprise Contract]
2022
** xref:how-to-guides/proc_delete_application.adoc[Deleting an application]
2123

docs/modules/ROOT/pages/getting-started/get-started.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ image::Environments.png[The Environments tab shows the type of your environment,
140140

141141
An environment is a set of compute resources that you can use to develop, test, and stage your applications. There is a development environment included for you so that you can explore {ProductName}.
142142

143-
For information about creating an application with your own cluster, refer to xref:how-to-guides/proc_creating_your_own_environment.adoc[Creating your own environment].
143+
For information about creating an application with your own cluster, refer to xref:how-to-guides/managing-environments/proc_creating_your_own_environment.adoc[Creating your own environment].
144144

145145
=== Examining your SBOM
146146

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
= Overview of {ProductName} environments
2+
3+
Environments represent infrastructure. You can use them to test, develop, and release your application to production. You can create two types of environments in {ProductName}:
4+
5+
* Static environments, to which you can deploy your application for development or production.
6+
* Temporary (ephemeral) environments, to which you can temporarily deploy your application during testing.
7+
8+
The following sections further explain these different environments and how you can use them.
9+
10+
== Static environments
11+
12+
By default, {ProductName} deploys your application to AWS through Red Hat OpenShift Service on AWS (ROSA). This default static environment runs your application for as long as you want. But you can host your application in a different static environment, using a bring your own cluster (BYOC) option.
13+
14+
Currently, with the BYOC option, you can use a static environment hosted by any of the major cloud providers — AWS, Azure, GCP, etc.
15+
16+
== Temporary environments
17+
18+
You might want to deploy your application as part of a custom integration test. For example, you might want to test if endpoints react in an expected manner, or to see if components react correctly to API queries.
19+
20+
Normally, {ProductName} runs integration tests in the static development environment. But to deploy your application during a test, you need a new environment. The static development environment might already host the latest version of your application.
21+
22+
This is the use case for temporary environments. You can configure {ProductName} to deploy your application to a temporary clone of the development environment. You can perform this configuration when adding an integration test. {ProductName} then clones the environment each time it performs the test. The temporary environment disappears after testing.
23+
24+
== Additional resources
25+
26+
* xref:how-to-guides/managing-environments/proc_creating_your_own_environment.adoc[Creating your own environment] with the BYOC option
27+
* xref:how-to-guides/testing_applications/proc_adding_an_integration_test.adoc[Adding an integration test] (step 7 discusses temporary environments)

0 commit comments

Comments
 (0)