Skip to content

Commit

Permalink
docs: update for connected and disconnected (#464)
Browse files Browse the repository at this point in the history
Updates the documentation to provide instructions for:
- Connected Environment (internet access)
- Disconnected Environment (dark-site / air-gapped)

Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
  • Loading branch information
tenthirtyam authored Jan 10, 2024
1 parent 77ee31e commit 6d9841e
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 47 deletions.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

The module helps reduce human error, delivers consistency and robustness, and accelerates the time-to-deploy these solutions. The module's cmdlets reduce complexity by automating the deployment and configuration steps using the product APIs or command-line tools.

This infrastructure-as-code model enables you to use the module to accelerate the deployment and management of the VMware Validate Solutions or use it in your own end-to-end automation.
This infrastructure-as-code model enables you to use the module to accelerate the deployment and management of the VMware Validated Solutions or use it in your own end-to-end automation.

## Requirements

Expand Down
88 changes: 44 additions & 44 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,73 @@
# Installing the Module

## From Powershell Gallery
Verify that your system has a [supported edition and version](index.md#powershell) of PowerShell installed.

Verify that your system has a [supported edition and version](/power-validated-solutions-for-cloud-foundation/#powershell) of PowerShell installed.
=== ":material-pipe: &nbsp; Connected Environment"

Install the PowerShell [module dependencies](/power-validated-solutions-for-cloud-foundation/#module-dependencies) from the PowerShell Gallery by running the following commands:
For environments connected to the Internet, you can install the [module dependencies](index.md#module-dependencies) from the PowerShell Gallery by running the following commands in the PowerShell console:
```powershell
--8<-- "./docs/snippets/install-module.ps1"
```

```powershell
--8<-- "./docs/snippets/install-module.ps1"
```
If using PowerShell Core, import the modules before proceeding:

If using PowerShell Core, import the modules before proceeding:
For example:

For example:
```powershell
--8<-- "./docs/snippets/import-module.ps1"
```

```powershell
--8<-- "./docs/snippets/import-module.ps1"
```
=== ":material-pipe-disconnected: &nbsp; Disconnected Environment"

## From Air-gapped Machine
For environments disconnected from the Internet _(e.g., dark-site, air-gapped)_, you can save the [module dependencies](index.md#module-dependencies) from the PowerShell Gallery by running the following commands in the PowerShell console:

Verify that your system has a [supported edition and version](/powershell-module-for-vmware-cloud-foundation-password-management/#powershell) of PowerShell installed.
=== ":fontawesome-brands-windows: &nbsp; Windows"

=== ":fontawesome-brands-windows: &nbsp; Windows"
From a system with an Internet connection, save the module dependencies from the PowerShell Gallery by running the following commands in the PowerShell console:

Save Modules [module dependencies](/powershell-module-for-vmware-cloud-foundation-password-management/#module-dependencies) from the PowerShell Gallery on a non air-gapped machine by running the following commands:
```powershell
--8<-- "./docs/snippets/save-module-local-windows.ps1"
```

```powershell
--8<-- "./docs/snippets/save-module-local-windows.ps1"
```
From the system with the Internet connection, copy the module dependencies to a target system by running the following commands in the PowerShell console:

Copy the PowerShell Modules [module dependencies](/powershell-module-for-vmware-cloud-foundation-password-management/#module-dependencies) from the Local Machine to air-gapped facing machine by running the following commands:
```powershell
--8<-- "./docs/snippets/copy-module-local-windows.ps1"
```

```powershell
--8<-- "./docs/snippets/copy-module-local-windows.ps1"
```
On the target system, import the module dependencies by running the following commands in the PowerShell console:

Import the PowerShell Modules [module dependencies](/powershell-module-for-vmware-cloud-foundation-password-management/#module-dependencies) from the air-gapped machine by running the following commands:
```powershell
--8<-- "./docs/snippets/import-module.ps1"
```

```powershell
--8<-- "./docs/snippets/import-module.ps1"
```
=== ":fontawesome-brands-linux: &nbsp; Linux"

=== ":fontawesome-brands-linux: &nbsp; Linux"
Prerequisite for module install on Linux Machine

Prerequisite for module install on Linux Machine
```bash
--8<-- "./docs/snippets/pre-req-linux.sh"
```

```bash
--8<-- "./docs/snippets/pre-req-linux.sh"
```
From a system with an Internet connection, save the module dependencies from the PowerShell Gallery by running the following commands in the PowerShell console:

Save Modules [module dependencies](/powershell-module-for-vmware-cloud-foundation-password-management/#module-dependencies) from the PowerShell Gallery on a non air-gapped machine by running the following commands:
```powershell
--8<-- "./docs/snippets/save-module-local-linux.ps1"
```

```powershell
--8<-- "./docs/snippets/save-module-local-linux.ps1"
```
From the system with an Internet connection, copy the module dependencies to a target system by running the following commands in the PowerShell console:

Copy the PowerShell Modules [module dependencies](/powershell-module-for-vmware-cloud-foundation-password-management/#module-dependencies) from the Local Machine to air-gapped facing machine by running the following commands:
```bash
--8<-- "./docs/snippets/copy-module-local-linux.sh"
```

```bash
--8<-- "./docs/snippets/copy-module-local-linux.sh"
```
On the target system, import the module dependencies by running the following commands in the PowerShell console:

Import the PowerShell Modules [module dependencies](/powershell-module-for-vmware-cloud-foundation-password-management/#module-dependencies) from the air-gapped machine by running the following commands in PowerShell:
```powershell
--8<-- "./docs/snippets/import-module-local-linux.ps1"
```

```powershell
--8<-- "./docs/snippets/import-module-local-linux.ps1"
```

To verify the correct versions of the supporting modules are installed, run the following command in the PowerShell console.

```powershell
Expand Down
2 changes: 1 addition & 1 deletion docs/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To verify that the PowerShell module is updated, run the following command in th
--8<-- "./docs/snippets/installed-module.ps1"
```

To verify the [module dependencies](/power-validated-solutions-for-cloud-foundation/#module-dependencies) meet the minimum requirements, use the `Test-PowerValidatedSolutionsPrereq` cmdlet.
To verify the [module dependencies](index.md#module-dependencies) meet the minimum requirements, use the `Test-PowerValidatedSolutionsPrereq` cmdlet.

If a dependency does not meet the minimum requirements, run the appropriate `Update-Module` command for the dependency in the PowerShell console.

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ edit_uri: blob/main/docs/

# Copyright
copyright: |
Copyright &copy; 2005-2023 Broadcom. All Rights Reserved.<br/>
Copyright &copy; 2005-2024 Broadcom. All Rights Reserved.<br/>
The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.<br/><br/>
# Configuration
Expand Down

0 comments on commit 6d9841e

Please sign in to comment.