Skip to content
This repository was archived by the owner on Dec 1, 2023. It is now read-only.

Commit 4512615

Browse files
authored
Merge pull request #15 from rubrikinc/mwp-issue12
Issue 12 - rename credential files
2 parents 26992c5 + b81a777 commit 4512615

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

docs/quick-start.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,14 @@ Alternatively, we can use the `Get-Module` cmdlet to verify if all modules are s
5757
The output shows that all modules are successfully installed on this system.
5858

5959
## Components
60-
In order to get started with Backup Validation there are several components that you need to understand. The PowerShell Modules that are required to run and connect to both vCenter cluster and Rubrik cluster, and the InvokeBuild module that will execute the build tasks.
60+
In order to get started with Backup Validation there are several components that you need to understand. The PowerShell Modules that are required to run and connect to both vCenter cluster and Rubrik cluster, and the InvokeBuild module that will execute the build tasks.
6161

6262
Then we will move on the different configuration and credential files and how these files tie into the backup validation process.
6363

6464
Finally, we will look at the `.build.ps1` file, what it contains and how we can make additions to this.
6565

6666
### PowerShell Modules
67-
This use case leverages several PowerShell modules, outlined in this section.
67+
This use case leverages several PowerShell modules, outlined in this section.
6868

6969
#### Rubrik SDK for PowerShell
7070
Rubrik’s API first architecture enables organizations to embrace and integrate Rubrik functionality into their existing automation processes. While Rubrik APIs can be consumed natively, companies are at various stages in their automation journey with different levels of automation knowledge on staff. The Rubrik SDK for PowerShell is a project that provides a Microsoft PowerShell module for managing and monitoring Rubrik's Cloud Data Management fabric by way of published RESTful APIs.
@@ -136,9 +136,9 @@ Use the [`generateCreds.ps1`](https://github.com/rubrikinc/PowerShell-Backup-Val
136136
param(
137137
$Path
138138
)
139-
140-
$CredType = @("rubrikCreds.xml","vmwareCreds.xml","guestCreds.xml")
141-
139+
140+
$CredType = @("rubrikCred.xml","vmwareCred.xml","guestCred.xml")
141+
142142
foreach ($Type in $CredType) {
143143
$Credential = Get-Credential -Message $Type
144144
$Credential | Export-Clixml -Path ($Path + "\" + $Type)
@@ -209,20 +209,20 @@ At the end of the script we will logically group together the different build ta
209209
```
210210
task 1_Init `
211211
GetConfig
212-
212+
213213
task 2_Connect `
214214
ConnectRubrik,
215215
ConnectVMware
216-
216+
217217
task 3_LiveMount `
218218
CreateLiveMount,
219219
ValidateLiveMount,
220220
ValidateLiveMountTools
221-
221+
222222
task 4_LiveMountNetwork `
223223
MoveLiveMountNetwork,
224224
MoveLiveMountNetworkAddress
225-
225+
226226
task 5_Testing `
227227
LiveMountTest
228228
```
@@ -255,7 +255,7 @@ task Ping {
255255
The `tests.ps1` file can be updated with additional tests, and once these tests have been created they can be added to the Config JSON files for the relevant systems.
256256

257257
## Validate Backup
258-
Now that we have all components in place, we will create our own backup validation workflow.
258+
Now that we have all components in place, we will create our own backup validation workflow.
259259

260260
### Prepare the Environment
261261
To get started we will download the Build Validation package and extract it to a folder named “Backup Validations”. The package is available in the [PowerShell-Backup-Validation](https://github.com/rubrikinc/Use-Case-PowerShell-Backup-Validation) repository. The zipped file is available for download [here](https://github.com/rubrikinc/PowerShell-Backup-Validation/archive/master.zip).
@@ -272,7 +272,7 @@ In the Config files a number of configuration options are available:
272272
* `mountName` - the name of the live mount
273273
* `guestCred` - the credentials file, only the filename is required, no path needs to be specified
274274
* `testIp` - IP Address configured for Live Mounted VM
275-
* `testNetwork` - virtual network used by the adapter of the Live Mount
275+
* `testNetwork` - virtual network used by the adapter of the Live Mount
276276
* `testGateway` - the gateway address of the network adapter
277277
* `tasks` - which tasks will run against this specific VM
278278

@@ -368,7 +368,7 @@ Get-RubrikVM | Get-Random | ForEach-Object {
368368
}
369369
```
370370

371-
This will select a random virtual machine and create a `config.json` which can then be used for backup validation.
371+
This will select a random virtual machine and create a `config.json` which can then be used for backup validation.
372372

373373
### Run `Invoke-Build`
374374
Once the Environment, Config, and Identity requirements are met, use the `Invoke-Build` function to execute a build. Here is a sample command using a PowerShell technique called splatting to store the parameters and arguments and execute `Invoke-Build`.
@@ -380,7 +380,7 @@ $Splat = @{
380380
ConfigFile = '.\config\TestConfiguration.json'
381381
IdentityPath = '.\credentials'
382382
}
383-
383+
384384
Invoke-Build @Splat -Result Result
385385
```
386386

helper/generateCreds.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ param(
22
$Path
33
)
44

5-
$CredType = @("rubrikCreds.xml","vmwareCreds.xml","guestCreds.xml")
5+
$CredType = @("rubrikCred.xml","vmwareCred.xml","guestCred.xml")
66

77
foreach ($Type in $CredType) {
88
$Credential = Get-Credential -Message $Type

0 commit comments

Comments
 (0)