-
Notifications
You must be signed in to change notification settings - Fork 80
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
Support azure migrate assessments #424
Changes from 15 commits
4c7ca89
e9a20a3
74ae5d7
2bf1277
f1c0d4e
1a38568
8d17b24
527df9e
1363fbf
5ab1e61
40c81f8
892221b
78ce9e7
6032a80
1f6adf5
ee421e1
d14856f
a267ecd
d27c5b6
c78f077
04cec98
74e8f7b
e523c42
ad22f46
e80007a
7a963a0
a600d5d
81f2d51
184013c
efd0214
d827add
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
--- | ||
title: About the azure_migrate_assessment Resource | ||
platform: azure | ||
--- | ||
|
||
# azure_migrate_assessment | ||
|
||
Use the `azure_migrate_assessment` InSpec audit resource to test the properties related to Azure Migrate Assessments. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Assessment is a generic term so it should be lowercase. The same goes for all the other uses of "assessment". It's also singular "assessment" in this resource, but plural in the other resource. |
||
|
||
## Azure REST API version, Endpoint, and HTTP Client Parameters | ||
|
||
This resource interacts with API versions supported by the resource provider. The `api_version` is defined as a resource parameter. | ||
If not provided, the latest version is used. For more information, refer to [`azure_generic_resource`](azure_generic_resource.md). | ||
|
||
Unless defined, `azure_cloud` global endpoint and default values for the HTTP client are used. For more information, refer to the resource pack [README](../../README.md). | ||
|
||
## Availability | ||
|
||
### Installation | ||
|
||
This resource is available in the [InSpec Azure resource pack](https://github.com/inspec/inspec-azure). For an example, `inspec.yml` file and how to set up your Azure credentials, refer to resource pack [README](../../README.md#Service-Principal). | ||
|
||
## Syntax | ||
|
||
`name` is a required parameter, and `resource_group` is an optional parameter. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Line 52 shows four required parameters, not two. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this is done |
||
|
||
```ruby | ||
describe azure_migrate_assessment(resource_group: 'MIGRATED_VMS', project_name: 'ZONEA_MIGRATE_ASSESSMENT_PROJECT', group_name: 'ZONEA_MACHINES_GROUP', NAME: 'ZONEA_MACHINES_MIGRATE_ASSESSMENT') do | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The placeholder values for the parameters should be more generic. So The same goes for the other code examples. |
||
it { should exist } | ||
its('name') { should cmp 'ZONEA_MACHINES_MIGRATE_ASSESSMENT' } | ||
its('type') { should cmp 'Microsoft.Migrate/assessmentprojects/groups/assessments' } | ||
end | ||
``` | ||
|
||
```ruby | ||
describe azure_migrate_assessment(resource_group: 'MIGRATED_VMS', project_name: 'ZONEA_MIGRATE_ASSESSMENT_PROJECT', group_name: 'ZONEA_MACHINES_GROUP', name: 'ZONEA_MACHINES_MIGRATE_ASSESSMENT') do | ||
it { should exist } | ||
end | ||
``` | ||
|
||
## Parameters | ||
|
||
| Name | Description | | ||
|----------------|----------------------------------------------------------------------------------| | ||
| name | Name of the Azure Migrate Assessment to test. | | ||
| resource_group | Azure resource group where the targeted resource resides in. `MyResourceGroup` | | ||
| project_name | Azure Migrate Assessment Project. | | ||
| group_name | Unique name of a group within a project. | | ||
|
||
The parameter set should be provided for a valid query: | ||
|
||
- `resource_group` and `project_name` and `group_name` and `name` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The |
||
|
||
## Properties | ||
|
||
| Property | Description | | ||
|-------------------------------|------------------------------------------------------------------| | ||
| id | Path reference to the assessment. | | ||
| name | Unique name of an assessment. | | ||
| type | Object type. `Microsoft.Migrate/assessmentProjects/groups/assessments` | | ||
| eTag | For optimistic concurrency control. | | ||
| properties | Properties of the assessment. | | ||
| properties.azureDiskType | Storage type selected for this disk. | | ||
| properties.currency | Currency to report prices in. | | ||
| properties.sizingCriterion | Assessment sizing criterion. | | ||
| properties.reservedInstance | Azure reserved instance. | | ||
|
||
For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`](azure_generic_resource.md#properties). | ||
|
||
Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/migrate/assessment/assessments/get) for other properties available. Any attribute in the response is accessed with the key names separated by dots (`.`). | ||
sathish-progress marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Examples | ||
|
||
### Test that the Migrate Assessments has a minimum scalingFactor | ||
sathish-progress marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```ruby | ||
describe azure_migrate_assessment(resource_group: 'MIGRATED_VMS', project_name: 'ZONEA_MIGRATE_ASSESSMENT_PROJECT', group_name: 'ZONEA_MACHINES_GROUP', name: 'ZONEA_MACHINES_MIGRATE_ASSESSMENT') do | ||
its('properties.scalingFactor') { should eq 1.0 } | ||
end | ||
``` | ||
|
||
## Matchers | ||
|
||
This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](/inspec/matchers/). | ||
|
||
### exists | ||
|
||
```ruby | ||
# If a Migrate Assessments is found, it will exist | ||
describe azure_migrate_assessment(resource_group: 'MIGRATED_VMS', project_name: 'ZONEA_MIGRATE_ASSESSMENT_PROJECT', group_name: 'ZONEA_MACHINES_GROUP', name: 'ZONEA_MACHINES_MIGRATE_ASSESSMENT') do | ||
it { should exist } | ||
end | ||
|
||
# if Migrate Assessments are not found, it will not exist | ||
describe azure_migrate_assessment(resource_group: 'MIGRATED_VMS', project_name: 'ZONEA_MIGRATE_ASSESSMENT_PROJECT', group_name: 'zONEA_MACHINES_GROUP', name: 'ZONEA_MACHINES_MIGRATE_ASSESSMENT') do | ||
it { should_not exist } | ||
end | ||
``` | ||
|
||
## Azure Permissions | ||
|
||
Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `contributor` role on the subscription you wish to test. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
--- | ||
title: About the azure_migrate_assessments Resource | ||
platform: azure | ||
--- | ||
|
||
# azure_migrate_assessments | ||
|
||
Use the `azure_migrate_assessments` InSpec audit resource to test the properties related to all Azure Migrate Assessments within a project. | ||
|
||
## Azure REST API version, Endpoint, and HTTP Client Parameters | ||
|
||
This resource interacts with API versions supported by the resource provider. The `api_version` is defined as a resource parameter. | ||
If not provided, the latest version is used. For more information, refer to [`azure_generic_resource`](azure_generic_resource.md). | ||
|
||
Unless defined, `azure_cloud` global endpoint and default values for the HTTP client is used. For more information, refer to the resource pack [README](../../README.md). | ||
|
||
## Availability | ||
|
||
### Installation | ||
|
||
This resource is available in the [InSpec Azure resource pack](https://github.com/inspec/inspec-azure). For an example, `inspec.yml` file and how to set up your Azure credentials, refer to resource pack [README](../../README.md#Service-Principal). | ||
|
||
## Syntax | ||
|
||
An `azure_migrate_assessments` resource block returns all Azure Migrate Assessments within a project. | ||
|
||
```ruby | ||
describe azure_migrate_assessments(resource_group: 'MIGRATED_VMS', project_name: 'ZONEA_MIGRATE_ASSESSMENT_PROJECT') do | ||
#... | ||
end | ||
``` | ||
|
||
## Parameters | ||
| Name | Description | | ||
|----------------|----------------------------------------------------------------------------------| | ||
| resource_group | Azure resource group that the targeted resource resides in. `MyResourceGroup` | | ||
| project_name | Azure Migrate Assessment Project. | | ||
|
||
The parameter set should be provided for a valid query: | ||
- `resource_group` and `project_name` | ||
|
||
## Properties | ||
|
||
|Property | Description | Filter Criteria<superscript>*</superscript> | | ||
|--------------------------------|------------------------------------------------------------------------|------------------| | ||
| ids | Path reference to the assessments. | `id` | | ||
| names | Unique names for all assessments. | `name` | | ||
| types | Type of the objects. | `type` | | ||
| eTags | A list of eTags for all the assessments. | `eTag` | | ||
| properties | A list of Properties for all the assessments. | `properties` | | ||
| azureDiskTypes | Storage type selected for the disk of all the assessments. | `azureDiskType` | | ||
| azureHybridUseBenefits | AHUB discount on windows virtual machines of all the assessments. | `azureHybridUseBenefit`| | ||
| azureLocations | Target Azure locations for which the machines should be assessed. | `azureLocation` | | ||
| azureOfferCodes | Offer codes according to which cost estimation is done. | `azureOfferCode` | | ||
| azurePricingTiers | Pricing tiers for Size evaluation. | `azurePricingTier`| | ||
| azureStorageRedundancies | Storage Redundancy types offered by Azure. | `azureStorageRedundancy`| | ||
| azureVmFamilies | List of azure VM families. | `azureVmFamilies`| | ||
| confidenceRatingInPercentages | Confidence rating percentages for assessment. | `confidenceRatingInPercentage`| | ||
| createdTimestamps | Time when this project is created. | `createdTimestamp` | | ||
| currencies | Currencies to report prices in. | `currency` | | ||
| discountPercentages | Custom discount percentages to be applied on final costs. | `discountPercentage`| | ||
| eaSubscriptionIds | Enterprise agreement subscription arm ids. | `eaSubscriptionId`| | ||
| monthlyBandwidthCosts | Monthly network cost estimates for the machines. | `monthlyBandwidthCost`| | ||
| monthlyComputeCosts | Monthly compute cost estimates for the machines. | `monthlyComputeCost`| | ||
| monthlyPremiumStorageCosts | Monthly premium storage cost estimates for the machines. | `monthlyPremiumStorageCost`| | ||
| monthlyStandardSSDStorageCosts | Monthly standard SSD storage cost estimates for the machines. | `monthlyStandardSSDStorageCost`| | ||
| monthlyStorageCosts | Monthly storage cost estimates for the machines. | `monthlyStorageCost` | | ||
| numberOfMachines | Number of assessed machines part of the assessments. | `numberOfMachines` | | ||
| percentiles | Percentiles of performance data used to recommend Azure size. | `percentile` | | ||
| perfDataEndTimes | End times to consider performance data for assessments. | `perfDataEndTime` | | ||
| perfDataStartTimes | Start times to consider performance data for assessments. | `perfDataStartTime` | | ||
| pricesTimestamps | Times when the Azure Prices are queried. | `pricesTimestamp` | | ||
| reservedInstances | Azure reserved instances. | `reservedInstance` | ||
| scalingFactors | Scaling factors used over utilization data to add a performance buffer for new machines to be created in Azure.| `scalingFactor` | | ||
| sizingCriterions | Assessment sizing criterions. | `sizingCriterion` | | ||
| stages | User configurable setting that describes the status of the assessments.| `stage` | | ||
| statuses | Whether the assessments have been created and is valid. | `status` | | ||
| timeRanges | Time ranges of performance data used to recommend a size. | `timeRange` | | ||
| updatedTimestamps | Times when the project is last updated. | `updatedTimestamp`| | ||
| vmUptimes | Specify the durations for which the VMs are up in the on-premises environment.| `vmUptime` | | ||
|
||
|
||
sathish-progress marked this conversation as resolved.
Show resolved
Hide resolved
|
||
<superscript>*</superscript> For information on how to use filter criteria on plural resources refer to [FilterTable usage](https://github.com/inspec/inspec/blob/master/dev-docs/filtertable-usage.md). | ||
|
||
## Examples | ||
|
||
### Loop through Migrate Assessments by their names | ||
|
||
```ruby | ||
azure_migrate_assessments(resource_group: 'MIGRATED_VMS', project_name: 'ZONEA_MIGRATE_ASSESSMENT_PROJECT').names.each do |name| | ||
describe azure_container_group(resource_group: 'MIGRATED_VMS', project_name: 'ZONEA_MIGRATE_ASSESSMENT_PROJECT', group_name: 'ZONEA_MACHINES_GROUP', name: name) do | ||
it { should exist } | ||
end | ||
end | ||
``` | ||
|
||
### Test to ensure Migrate Assessments with local redundancy | ||
sathish-progress marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```ruby | ||
describe azure_migrate_assessments(resource_group: 'MIGRATED_VMS', project_name: 'ZONEA_MIGRATE_ASSESSMENT_PROJECT').where(azureStorageRedundancy: 'LOCALLYREDUNDANT') do | ||
it { should exist } | ||
end | ||
``` | ||
|
||
## Matchers | ||
|
||
This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). | ||
|
||
### exists | ||
|
||
```ruby | ||
# Should not exist if no Migrate Assessments are present in the project and in the resource group | ||
describe azure_migrate_assessments(resource_group: 'MIGRATED_VMS', project_name: 'ZONEA_MIGRATE_ASSESSMENT_PROJECT') do | ||
it { should_not exist } | ||
end | ||
|
||
# Should exist if the filter returns at least one Migrate Assessment in the project and in the resource group | ||
describe azure_migrate_assessments(resource_group: 'MIGRATED_VMS', project_name: 'ZONEA_MIGRATE_ASSESSMENT_PROJECT') do | ||
it { should exist } | ||
end | ||
``` | ||
|
||
## Azure Permissions | ||
|
||
Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `contributor` role on the subscription you wish to test. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
require 'azure_generic_resource' | ||
|
||
class AzureMigrateAssessment < AzureGenericResource | ||
name 'azure_migrate_assessment' | ||
desc 'Retrieves and verifies the settings of a container group instance.' | ||
example <<-EXAMPLE | ||
describe azure_migrate_assessment(resource_group: 'migrated_vms', project_name: 'zoneA_migrate_assessment_project', group_name: 'zoneA_machines_group', name: 'zoneA_machines_migrate_assessment') do | ||
it { should exist } | ||
end | ||
EXAMPLE | ||
|
||
def initialize(opts = {}) | ||
raise ArgumentError, 'Parameters must be provided in an Hash object.' unless opts.is_a?(Hash) | ||
|
||
opts[:resource_provider] = specific_resource_constraint('Microsoft.Migrate/assessmentProjects', opts) | ||
opts[:required_parameters] = %i(project_name group_name name) | ||
opts[:resource_path] = [opts[:project_name], 'groups', opts[:group_name], 'assessments'].join('/') | ||
super(opts, true) | ||
end | ||
|
||
def to_s | ||
super(AzureMigrateAssessment) | ||
end | ||
end | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. to_s implementation is missing . There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
require 'azure_generic_resources' | ||
|
||
class AzureMigrateAssessments < AzureGenericResources | ||
name 'azure_migrate_assessments' | ||
desc 'Verifies settings for a collection of Azure Migrate Assessments in a project' | ||
example <<-EXAMPLE | ||
describe azure_migrate_assessments(resource_group: 'migrated_vms', project_name: 'zoneA_migrate_assessment_project') do | ||
it { should exist } | ||
end | ||
EXAMPLE | ||
|
||
def initialize(opts = {}) | ||
raise ArgumentError, 'Parameters must be provided in an Hash object.' unless opts.is_a?(Hash) | ||
opts[:resource_provider] = specific_resource_constraint('Microsoft.Migrate/assessmentProjects', opts) | ||
opts[:required_parameters] = %i(project_name) | ||
opts[:resource_path] = [opts[:project_name], 'assessments'].join('/') | ||
super(opts, true) | ||
return if failed_resource? | ||
|
||
populate_filter_table_from_response | ||
end | ||
|
||
def to_s | ||
super(AzureMigrateAssessments) | ||
end | ||
|
||
private | ||
|
||
def populate_table | ||
@resources.each do |resource| | ||
@table << resource.merge(resource[:properties]) | ||
end | ||
end | ||
end | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. to_s implementation is missing . There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't need this change.