https://github.com/rubrikinc/use-case-powershell-backup-validation
Recovery Validation Framework with PowerShell
https://github.com/rubrikinc/use-case-powershell-backup-validation
powershell rubrik use-case
Last synced: 8 months ago
JSON representation
Recovery Validation Framework with PowerShell
- Host: GitHub
- URL: https://github.com/rubrikinc/use-case-powershell-backup-validation
- Owner: rubrikinc
- License: mit
- Created: 2017-08-18T23:07:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-11-16T14:41:00.000Z (about 5 years ago)
- Last Synced: 2023-02-28T10:05:42.249Z (almost 3 years ago)
- Topics: powershell, rubrik, use-case
- Language: PowerShell
- Homepage: https://build.rubrik.com/use-cases/backup-validation/
- Size: 828 KB
- Stars: 10
- Watchers: 9
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# PowerShell Backup Validation
This project is used to provide a framework for serial and parallel application testing against workloads that have been protected by Rubrik's Cloud Data Management platform.
Using the `Invoke-Build` framework, this project allows for an administrator to declare the topology of an application across one or more virtual machines. The entire collection of virtual machines are Live Mounted as a group and a battery of user-defined tests are applied. Upon the completion of the tests, the Live Mounts are removed and a summary of results are displayed.
# :white_check_mark: Prerequisites
There are a few services you'll need in order to get this project off the ground:
* [PowerShell](https://aka.ms/getps6)
* [Rubrik PowerShell Module](https://www.powershellgallery.com/packages/Rubrik/)
* [Rubrik PowerShell Backup Validation Module](https://github.com/rubrikinc/rubrik-module-for-powershell-backup-validation)
* [VMware PowerCLI](https://www.powershellgallery.com/packages/VMware.PowerCLI/)
* [InvokeBuild](https://www.powershellgallery.com/packages/InvokeBuild/)
# :hammer: Installation
This folder can be dropped anywhere on your workstation that has network connectivity to a Rubrik cluster and related vCenter Server.
## Configuration
There are three main points of configuration: Environment JSON files, Config JSON files, and Identity XML files.
### Environment JSON Files
The `Environment` folder contains JSON files that describe the Rubrik Cluster and vCenter Server information. A sample configuration looks like:
```PowerShell
{
"rubrikServer": "172.17.28.11",
"rubrikCred": "rubrikCred.xml",
"vmwareServer": "172.17.48.22",
"vmwareCred": "vmwareCred.xml"
}
```
### Config JSON Files
The `Config` folder contains JSON files that describe the virtual machines being tested. A sample configuration looks like:
```PowerShell
{
"virtualMachines": [
{
"name": "SE-CWAHL-WIN",
"mountName": "MOUNT-2TIER-APP",
"guestCred": "guestCred.xml",
"testIp": "172.17.50.121",
"testNetwork": "VLAN50_Servers_Mount",
"testGateway": "172.17.50.1",
"tasks": ["Ping","Netlogon"]
},
{
"name": "SE-CWAHL-WIN",
"mountName": "MOUNT-2TIER-DB",
"guestCred": "guestCred.xml",
"testIp": "172.17.50.122",
"testNetwork": "VLAN50_Servers_Mount",
"testGateway": "172.17.50.1",
"tasks": ["Ping","Netlogon"]
}
]
}
```
### Identity
The `Identity` folder is not included in this repository. It can be placed anywhere in your environment and should host secure XML files created with `Export-Clixml` containing the credentials needed to communicate with the Rubrik cluster, vCenter Server, and any guest operating systems involved in the application testing.
Use the [generateCreds.ps1](https://github.com/rubrikinc/PowerShell-Backup-Validation/blob/master/helper/generateCreds.ps1) file to create a starter set of credentials or see how the generation process works.
_Note: Secure XML files can only be decrypted by the user account that created them._
## Usage
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 splat.
```PowerShell
$Splat = @{
File = '..\.build.ps1'
EnvironmentFile = '.\environment\se-2.json'
ConfigFile = '.\config\1-tier-app.json'
IdentityPath = '.\credential\laptop'
}
Invoke-Build @Splat -Result Result
```
# :blue_book: Documentation
Here are some resources to get you started! If you find any challenges from this project are not properly documented or are unclear, please [raise an issue](https://github.com/rubrikinc/use-case-powershell-backup-validation/issues/new/choose) and let us know! This is a fun, safe environment - don't worry if you're a GitHub newbie! :heart:
* [Quick Start Guide](https://github.com/rubrikinc/Use-Case-PowerShell-Backup-Validation/blob/master/docs/quick-start.md)
* [Rubrik SDK for Powershell Documentation](http://rubrikinc.github.io/rubrik-sdk-for-powershell/)
* [Rubrik API Documentation](https://github.com/rubrikinc/api-documentation)
* [VIDEO: Getting Started with the Backup Validation Use Case](https://www.youtube.com/watch?v=OCmFpno268M&feature=youtu.be)
# :muscle: How You Can Help
We glady welcome contributions from the community. From updating the documentation to adding more tests for this framework, all ideas are welcome. Thank you in advance for all of your issues, pull requests, and comments! :star:
* [Contributing Guide](CONTRIBUTING.md)
* [Code of Conduct](CODE_OF_CONDUCT.md)
# :pushpin: License
* [MIT License](LICENSE)
# :point_right: About Rubrik Build
We encourage all contributors to become members. We aim to grow an active, healthy community of contributors, reviewers, and code owners. Learn more in our [Welcome to the Rubrik Build Community](https://github.com/rubrikinc/welcome-to-rubrik-build) page.
We'd love to hear from you! Email us: build@rubrik.com :love_letter: