Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update for connected and disconnected #203

Merged
merged 1 commit into from
Dec 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/documentation/getting-started/alert-report.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Generating Alert Reports

The [`Invoke-VcfAlertReport`](../../functions/Invoke-VcfAlertReport) cmdlet generates a system alert report. This report collects information about the system alerts that are currently active in the VMware Cloud Foundation system for the platform components. This report reduces the need to login to multiple product interfaces to collect information about the system alerts.
The [`Invoke-VcfAlertReport`](../functions/Invoke-VcfAlertReport.md) cmdlet generates a system alert report. This report collects information about the system alerts that are currently active in the VMware Cloud Foundation system for the platform components. This report reduces the need to login to multiple product interfaces to collect information about the system alerts.

## Only Issues

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Generating Configuration Reports

The [`Invoke-VcfConfigReport`](../../functions/Invoke-VcfConfigReport) cmdlet generates a configuration report. This report collects information about the configuration settings in a VMware Cloud Foundation system for the platform components. This report reduces the need to login to multiple product interfaces and endpoints to collect information about the configuration.
The [`Invoke-VcfConfigReport`](../functions/Invoke-VcfConfigReport.md) cmdlet generates a configuration report. This report collects information about the configuration settings in a VMware Cloud Foundation system for the platform components. This report reduces the need to login to multiple product interfaces and endpoints to collect information about the configuration.

## VMware Cloud Foundation Instance

Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/getting-started/health-report.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Generating Health Reports

The [`Invoke-VcfHealthReport`](../../functions/Invoke-VcfHealthReport) cmdlet generates a health report. This report combines the SoS Utility health checks with additional health checks not presently available in the SoS Utility. The report contains detailed information about the health of the VMware Cloud Foundation system and its components.
The [`Invoke-VcfHealthReport`](../functions/Invoke-VcfHealthReport.md) cmdlet generates a health report. This report combines the SoS Utility health checks with additional health checks not presently available in the SoS Utility. The report contains detailed information about the health of the VMware Cloud Foundation system and its components.

## Only Issues

Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/getting-started/overview-report.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Generating an Overview Report

The [`Invoke-VcfOverviewReport`](../../functions/Invoke-VcfOverviewReport) cmdlet generates a system overview report. This report contains high-level information about the VMware Cloud Foundation system. This report may be used to provide a quick system overview of the system to your VMware representative.
The [`Invoke-VcfOverviewReport`](../functions/Invoke-VcfOverviewReport.md) cmdlet generates a system overview report. This report contains high-level information about the VMware Cloud Foundation system. This report may be used to provide a quick system overview of the system to your VMware representative.

## Generate an Overview Report for a VMware Cloud Foundation Instance

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Generating an Upgrade Precheck Report

The [`Invoke-VcfUpgradePrecheck`](../../functions/Invoke-VcfUpgradePrecheck) cmdlet initiates an upgrade precheck of a workload domain using the REST API and presents the results in an HTML report. This allows you to start the precheck from the PowerShell console.
The [`Invoke-VcfUpgradePrecheck`](../functions/Invoke-VcfUpgradePrecheck.md) cmdlet initiates an upgrade precheck of a workload domain using the REST API and presents the results in an HTML report. This allows you to start the precheck from the PowerShell console.

## Start an Upgrade Precheck for a Workload Domain

Expand Down
101 changes: 51 additions & 50 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,83 @@
# 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](/powershell-module-for-vmware-cloud-foundation-reporting/#powershell) of PowerShell installed.
=== ":material-pipe:   Connected Environment"

Install the PowerShell [module dependencies](/powershell-module-for-vmware-cloud-foundation-reporting/#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 7 (Core), import the modules before proceeding:

For example:
For example:

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

To verify the module dependencies are installed, run the following commands in the PowerShell console.
To verify the module dependencies are installed, run the following commands in the PowerShell console.

**Example**:
**Example**:

```powershell
--8<-- "./docs/snippets/vars-vcf.ps1"
Test-VcfReportingPrereq -sddcManagerFqdn $sddcManagerFqdn -sddcManagerUser $sddcManagerUser -sddcManagerPass $sddcManagerPass
```
```powershell
--8<-- "./docs/snippets/vars-vcf.ps1"
Test-VcfReportingPrereq -sddcManagerFqdn $sddcManagerFqdn -sddcManagerUser $sddcManagerUser -sddcManagerPass $sddcManagerPass
```

## From Air-gapped Machine
=== ":material-pipe-disconnected: &nbsp; Disconnected Environment"

Verify that your system has a [supported edition and version](/powershell-module-for-vmware-cloud-foundation-password-management/#powershell) of PowerShell installed.
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:

=== ":fontawesome-brands-windows: &nbsp; Windows"
=== ":fontawesome-brands-windows: &nbsp; Windows"

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:
From a system with an Internet connection, save the module dependencies from the PowerShell Gallery by running the following commands in the PowerShell console:

```powershell
--8<-- "./docs/snippets/save-module-local-windows.ps1"
```
```powershell
--8<-- "./docs/snippets/save-module-local-windows.ps1"
```

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:
From the system with the Internet connection, copy the module dependencies to a target system by running the following commands in the PowerShell console:
tenthirtyam marked this conversation as resolved.
Show resolved Hide resolved

```powershell
--8<-- "./docs/snippets/copy-module-local-windows.ps1"
```
```powershell
--8<-- "./docs/snippets/copy-module-local-windows.ps1"
```

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:
On the target system, import the module dependencies by running the following commands in the PowerShell console:

```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 installation on Linux.

```bash
--8<-- "./docs/snippets/pre-req-linux.sh"
```
```bash
--8<-- "./docs/snippets/pre-req-linux.sh"
```

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:
From a system with an Internet connection, save the module dependencies from the PowerShell Gallery by running the following commands in the PowerShell console:

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

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:
From the system with an Internet connection, copy the module dependencies to a target system by running the following commands in the PowerShell console:
tenthirtyam marked this conversation as resolved.
Show resolved Hide resolved

```bash
--8<-- "./docs/snippets/copy-module-local-linux.sh"
```
```bash
--8<-- "./docs/snippets/copy-module-local-linux.sh"
```

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:
On the target system, import the module dependencies by running the following commands in the PowerShell console:

```powershell
--8<-- "./docs/snippets/import-module-local-linux.ps1"
```
:material-information-slab-circle: &nbsp; [Reference](/powershell-module-for-vmware-cloud-foundation-reporting/documentation/functions/Test-VcfReportingPrereq/)
```powershell
--8<-- "./docs/snippets/import-module-local-linux.ps1"
```

:material-information-slab-circle: &nbsp; [Reference](./documentation/functions/Test-VcfReportingPrereq.md)

Once installed, any cmdlets associated with `VMware.CloudFoundation.Reporting` and the its dependencies will be available for use.

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](/powershell-module-for-vmware-cloud-foundation-reporting/#module-dependencies) meet the minimum requirements, use the [`Test-VcfReportingPrereq`](/powershell-module-for-vmware-cloud-foundation-reporting/documentation/functions/Test-VcfReportingPrereq/) cmdlet.
To verify the [module dependencies](index.md#module-dependencies) meet the minimum requirements, use the [`Test-VcfReportingPrereq`](./documentation/functions/Test-VcfReportingPrereq.md) 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
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ markdown_extensions:
- attr_list
- md_in_html
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- material/.icons
Expand Down