NetApp OnCommand Cloud Manager and ONTAP Cloud

A cookbook to manage OCCM and ONTAP Cloud deployments

This cookbook installs, configures and manages NetApp OnCommand Cloud Manager systems. The included resources also deploy, manage and destroy NetApp ONTAP Cloud systems.

Table of Contents generated with DocToc

Requirements
Node Attributes
- OnCommand Cloud Manager
- ONTAP Cloud
Custom Resource
Recipes
Upload to Chef Server
Matchers/Helpers
- Matchers
- Helpers
Cookbook Testing
Contribute
License & Authors

Requirements

Platforms

Centos 7.1 and 7.2
Redhat 7.1 and 7.2
Official AWS Machine Image (Ami)

Chef

Chef 12.5+

Cookbooks

There are currently no outside dependencies

Data bags

Optional Data_bag occm and item aws. Handles AWS keys to be passed during initial OCCM setup.

{
  "id": "aws",
  "aws_access_key": "AKIA################",
  "aws_secret_key": "29######################################"
}

Required Data_bag occm and item admin_credentials. Handles OCCM Admin credentials used in recipes.

{
  "id": "admin_credentials",
  "email_address": "test@lab.test",
  "password": "Netapp1"
}

Required Data_bag occm and item <ontap-cloud-name>. Handles ONTAP Cloud Cluster Admin credentials assigned to the controller.

{
  "id": "demolab",
  "svm_password": "Netapp123"
}

Amazon Web Services

OnCommand Cloud Manager for AWS Machine Image

This cookbook can create a local or remote OnCommand Cloud Manager host. If deployed in Amazon, we advise using the existing NetApp AWS Marketplace Machine Image (OCCM-AMI). Visit the official page for OnCommand Cloud Manager in the AWS Marketplace for more information.

ONTAP Cloud for AWS

This cookbook will need access to your Amazon Web Services account and details contained therein. As part of the process, we will deploy ONTAP Cloud for AWS systems. Before this can happen, you must accept the official NetApp ONTAP Cloud Amazon Machine Image (ONTAP-AMI) end user license agreement. Visit the official page for ONTAP Cloud in the AWS Marketplace for more information.

Cloud Manager Admin credentials for AWS

The OnCommand Cloud Manager system requires that credentials exist either for the individual user or, if running in AWS, an IAM Instance Role for the EC2 server with the correct policy. Review the official IAM policy requirements for OCCM

Node Attributes

OnCommand Cloud Manager

node['occm']['server'] - String. Hostname or IP address of the OnCommand Cloud Manager system. Default is localhost.
node['occm']['company_name'] - String. Company name to which this installation should be registered.
node['occm']['tenant_name'] - String. The tenant name in OCCM. Default value is 'Default Tenant'
node['occm']['installer'] - URL. Full HTTP path to the installation media. Default is nil. Not required except when performing a local installation or not using the official Cloud Instance
node['occm']['install_pkg'] - Boolean. Determines if the setup recipe should also install OCCM. Default is false

ONTAP Cloud

node['ontap_cloud']['ontap']['standalone']['name'] - String. ONTAP Cloud system name.
Value must match regex: [/^[A-Za-z][A-Za-z0-9_]{2,39}$/]
node['ontap_cloud']['ontap']['standalone']['ebs_type'] - String. AWS EBS Volume type. Supported values are ['gp2', 'st1', 'sc1']. Default value is 'gp2'
node['ontap_cloud']['ontap']['standalone']['size'] - String. Size of the EBS Volume. Supported values are ['100GB', '500GB', '1TB', '2TB', '4TB', '8TB']. Default value is '1TB'
node['ontap_cloud']['ontap']['standalone']['instance_type'] - String. ONTAP Cloud for AWS instance type. Default value is 'm4.xlarge'.
node['ontap_cloud']['ontap']['standalone']['license_type'] - String. ONTAP Cloud license type. Supported values are ['cot-explore-paygo', 'cot-standard-paygo', 'cot-premium-paygo']. Default value is 'cot-explore-paygo'
node['ontap_cloud']['aws']['region'] - String. Required for AWS deployments.
Value must match regex:[/^[a-z]{2}-[a-z]+-\d$/]
node['ontap_cloud']['aws']['vpc_id'] - String. Required for AWS deployments.
Value must match regex: [/^vpc-[a-zA-Z0-9]{8}$/]
node['ontap_cloud']['aws']['subnet_id'] - String. Required for AWS deployments.
Value must match regex: [/^subnet-[a-zA-Z0-9]{8}$/]
node['ontap_cloud']['ontap']['standalone']['write_speed'] - String. Valid values are 'normal' or 'high'. Note: setting the value to high can potentially cause lost writes in the event of a failure. Set this value at your discretion.

Add Aggregate

node['ontap_cloud']['ontap']['standalone']['aggregate']['name'] - String. New Aggregate name.
Value must match regex: [/^[A-Za-z][A-Za-z0-9_]{2,39}$/]
node['ontap_cloud']['ontap']['standalone']['aggregate']['disk_count'] - Integer. Optionally adds disks to an existing aggregate.
node['ontap_cloud']['ontap']['standalone']['aggregate']['size'] - String. Size of the EBS Volume. Supported values are ['100GB', '500GB', '1TB', '2TB', '4TB', '8TB']. Default value matches node['ontap_cloud']['ontap']['standalone']['size'] if set
node['ontap_cloud']['ontap']['standalone']['aggregate']['ebs_type'] - String. String. AWS EBS Volume type. Supported values are ['gp2', 'st1', 'sc1']. Default value matches node['ontap_cloud']['ontap']['standalone']['ebs_type'] if set

Custom Resource

netapp_ontap_cloud_occm

Manages an existing OnCommand Cloud Manager setup

Action :setup

Configures OnCommand Cloud Manager first-time setup

Properties

NOTE: properties in bold are required

Server Configuration properties

Property	Type	Description
`server`	String	Hostname or IP address of the OnCommand Cloud Manager system
`email_address`	String	Email address assigned to the newly created user for first-time setup
`password`	String	Password for the user used in the setup. Sensitve and will not print in the logs.
`company`	String	Company name to which this installation should be registered
`site`	String	Site or Datacenter to where the OnCommand Cloud Manager system is deployed

User Management properties

Property	Type	Description
`first_name`	String	First name of the User to manage. Default is 'occm'
`last_name`	String	Last name of the User to manage. Default is 'admin'
`role_name`	String	Sets the access level of the user. Valid options ['Cloud Manager Admin', 'Tenant Admin', 'Working Environment Admin'] Default is 'Cloud Manager Admin'

Tenant properties

Property	Type	Description
`tenant_name`	String	Name of the OnCommand Cloud Manager Tenant.
`description`	String	Optional long description for the OCCM Tenant.
`cost_center`	String	Optional cost-center identifier for the OCCM Tenant.

AWS properties

Property	Type	Description
`aws_key`	String	Used to add AWS credentials to the newly created user. If none supplied, then provisioning of ONTAP Cloud systems will be disabled. Sensitve and will not print in the logs. NOTE: When running in AWS, an instance role can be assigned to the Cloud Manager system and these credentials can be skipped.
`aws_secret`	String	Used to add AWS credentials to the newly created user. If none supplied, then provisioning of ONTAP Cloud systems will be disabled. Sensitve and will not print in the logs. NOTE: When running in AWS, an instance role can be assigned to the Cloud Manager system and these credentials can be skipped.

Examples

Configure a minimal installation of Cloud Manager without AWS credentials

netapp_ontap_cloud_occm 'Setup Cloud Manager' do
  server 'localhost'
  email_address 'occm@lab.test'
  password 'Netapp1'
  company 'My Company'
  tenant_name 'Default Tenant'
  action :setup
end

netapp_ontap_cloud_ontap_aws

Deploys and configures ONTAP Cloud in AWS systems

Action :create

Deploys an ONTAP Cloud for AWS system

Properties

NOTE: properties in bold are required

OnCommand Cloud Manager properties

Property	Type	Description
`server`	String	Hostname or IP address of the OnCommand Cloud Manager system
`occm_user`	String	Email address of the OCCM user
`occm_password`	String	Password for the user supplied
`ontap_name`	String	NAME Property. The name of the ONTAP Cloud system to be created. This is the name property for the resource block. Value must match regex: [/^[A-Za-z][A-Za-z0-9_]{2,39}$/]
`tenant_name`	String	OCCM Tenant name to which the user has access and the new ONTAP Cloud will be deployed

Amazon Web Services properties

Property	Type	Description
`region`	String	The region to which the OCCM server can communicate and the new ONTAP Cloud should be deployed. Value must match regex:[/^[a-z]{2}-[a-z]+-\d$/]
`vpc_id`	String	The AWS VPC to which the OCCM server can communicate and the new ONTAP Cloud should be deployed. Value must match regex: [/^vpc-[a-zA-Z0-9]{8}$/]
`subnet_id`	String	The subnet in the VPC to which the OCCM server can communicate and the new ONTAP Cloud should be deployed. Value must match regex: [/^subnet-[a-zA-Z0-9]{8}$/]
`aws_tags`	String	Future Property

ONTAP Instance properties

Property	Type	Description
`instance_type`	String	AWS Instance Type. Default value is 'm4.xlarge'.
`license_type`	String	NetApp license type. Supported values are ['cot-explore-paygo', 'cot-standard-paygo', 'cot-premium-paygo']. Devault value is 'cot-explore-paygo'
`ontap_version`	String	Sets the version of ONTAP to deploy. Default is 'latest'
`use_latest`	Booelean	Should be set to `true` if ontap_version is `latest`. Default is true
`platform_license`	String	Future Property
`ebs_volume_type`	String	Sets the AWS EBS volume type for new storage attached to the ONTAP Cloud system. Supported values are 'gp2','st1','sc1'. Default value is 'gp2'
`ebs_volume_size`	String	Configures the EBS volume size. Supported values are '100GB','500GB','1TB','2TB','4TB','8TB'. Default value is '1TB'
`bypass_snapshot`	Booelean	Skips the default action by OCCM to create an EBS snapshot on first instantiation of ONTAP Cloud.
`data_encryption_type`	String	Future Property. Supported values are 'NONE', 'AWS', 'ONTAP'. Default value is 'NONE'
`clusterKeyPairName`	String	Future Property
`svm_password`	String	Sets the password on the cluster admin account for the ONTAP Cloud system. Sensitve and will not print in the logs.
`write_speed`	String	Determines the write_speed of the system. Valid values are 'normal' or 'high'. Note: setting the value to high can potentially cause lost writes in the event of a failure. Set this value at your discretion.

Examples

Deploy ONTAP Cloud instance and wait for launch to complete

netapp_ontap_cloud_ontap_aws 'myontap' do
  server 'localhost'
  occm_user 'occm@lab.test'
  occm_password 'Netapp1'
  tenant_name 'Default Tenant'
  svm_password 'Netapp123'
  region 'us-east-1'
  vpc_id 'vpc-12345678'
  subnet_id 'subnet-1a2b3c4d'
  ebs_volume_size '100GB'
  bypass_snapshot true
  action :create
end

Action :set_write_speed

Updates the write_speed for an existing ONTAP Cloud system:

NOTE: Modification of the write_speed will require that the ONTAP Cloud system be rebooted. This will cause a service disruption to any existing connected clients and servers.

Properties

NOTE: properties in bold are required

OnCommand Cloud Manager properties

Property	Type	Description
`server`	String	Hostname or IP address of the OnCommand Cloud Manager system
`occm_user`	String	Email address of the OCCM user
`occm_password`	String	Password for the user supplied
`ontap_name`	String	NAME Property. The name of the ONTAP Cloud system to be created. This is the name property for the resource block. Value must match regex: [/^[A-Za-z][A-Za-z0-9_]{2,39}$/]
`write_speed`	String	Determines the write_speed of the system. Valid values are 'normal' or 'high'. Note: setting the value to high can potentially cause lost writes in the event of a failure. Set this value at your discretion.

Examples

Modify the write_speed of an existing ONTAP Cloud system

netapp_ontap_cloud_ontap_aws 'demolab' do
  server 'localhost'
  occm_user 'test@lab.test'
  occm_password 'netapp123'
  write_speed 'high'
  action :set_write_speed
end

Action :delete

Destroys an ONTAP Cloud for AWS system

Properties

NOTE: properties in bold are required

OnCommand Cloud Manager properties

Property	Type	Description
`server`	String	Hostname or IP address of the OnCommand Cloud Manager system
`occm_user`	String	Email address of the OCCM user
`occm_password`	String	Password for the user supplied
`ontap_name`	String	NAME Property. The name of the ONTAP Cloud system to be created. This is the name property for the resource block. Value must match regex: [/^[A-Za-z][A-Za-z0-9_]{2,39}$/]

Examples

Delete an existing ONTAP Cloud system

netapp_ontap_cloud_ontap_aws 'Remove ONTAP Cloud' do
  server 'localhost'
  occm_user 'test@lab.test'
  occm_password 'netapp123'
  ontap_name 'old_demolab'
  action :delete
end

netapp_ontap_cloud_aggregate

Configures ONTAP Cloud aggregates

Action :create

Creates a new ONTAP Cloud aggregate

Properties

NOTE: properties in bold are required

OnCommand Cloud Manager properties

Property	Type	Description
`server`	String	Hostname or IP address of the OnCommand Cloud Manager system
`occm_user`	String	Email address of the OCCM user
`occm_password`	String	Password for the user supplied
`ontap_name`	String	NAME Property. The name of the ONTAP Cloud system to be created. Value must match regex: [/^[A-Za-z][A-Za-z0-9_]{2,39}$/]

ONTAP Instance properties

Property	Type	Description
`aggregate`	String	New Aggregate name. This is the name property for the resource block.
`disk_count`	Integer	Number of new disks of selected type to be included in the creation of the aggregate. Default is 1
`ebs_volume_type`	String	Sets the AWS EBS volume type for new storage attached to the ONTAP Cloud system. Supported values are 'gp2','st1','sc1'. Default value is 'gp2'
`ebs_volume_size`	String	Configures the EBS volume size. Supported values are '100GB','500GB','1TB','2TB','4TB','8TB'. Default value is '1TB'

Examples

Add a new aggregate to an existing ONTAP Cloud system

netapp_ontap_cloud_aggregate 'aggr_new' do
  server 'localhost'
  occm_user 'test@lab.test'
  occm_password 'netapp123'
  ontap_name 'demolab'
  disk_count 1
  ebs_volume_size '100GB'
  ebs_volume_type 'gp2'
  action :create
end

Action :add

Adds a new disk to an existing ONTAP Cloud Aggregate

Properties

NOTE: properties in bold are required

OnCommand Cloud Manager properties

Property	Type	Description
`server`	String	Hostname or IP address of the OnCommand Cloud Manager system
`occm_user`	String	Email address of the OCCM user
`occm_password`	String	Password for the user supplied
`ontap_name`	String	NAME Property. The name of the ONTAP Cloud system to be created. This is the name property for the resource block. Value must match regex: [/^[A-Za-z][A-Za-z0-9_]{2,39}$/]

ONTAP Instance properties

Property	Type	Description
`aggregate`	String	Existing Aggregate name. This is the name property for the resource block.
`disk_count`	Integer	Number of new disks of selected type to be included in the addition to the aggregate. Default is 1

Examples

Add a new disk to an existing aggregate for the selected ONTAP Cloud system

netapp_ontap_cloud_aggregate 'aggr1' do
  server 'localhost'
  occm_user 'test@lab.test'
  occm_password 'netapp123'
  ontap_name 'demolab'
  disk_count 1
  action :add
end

Action :delete

Delete an unused ONTAP Cloud Aggregate. Note: This process will fail if there are existing volumes

Properties

NOTE: properties in bold are required

OnCommand Cloud Manager properties

Property	Type	Description
`server`	String	Hostname or IP address of the OnCommand Cloud Manager system
`occm_user`	String	Email address of the OCCM user
`occm_password`	String	Password for the user supplied
`ontap_name`	String	NAME Property. The name of the ONTAP Cloud system to be created. This is the name property for the resource block. Value must match regex: [/^[A-Za-z][A-Za-z0-9_]{2,39}$/]

ONTAP Instance properties

Property	Type	Description
`aggregate`	String	Existing Aggregate name. This is the name property for the resource block.

Examples

Delete ONTAP Cloud instance and wait for completion

netapp_ontap_cloud_aggregate 'aggr_new' do
  server 'localhost'
  occm_user 'occm@lab.test'
  occm_password 'Netapp1'
  action :delete
end

netapp_ontap_cloud_ndvp (deprecated)

This resource was removed and is available in the Netapp Docker cookbook

Recipes

default

This is an empty recipe and should not be used

occm_install

Installs NetApp OnCommand Cloud Manager application. This recipe does not perform the setup or configuration

occm_setup

Installs and configures NetApp OnCommand Cloud Manager service using the default configuration and setup. Includes the recipe::occm_install.

ontap_cloud_aws_standalone

Configures NetApp OnCommand Cloud Manager service using the default configuration and setup. Deploys a new ONTAP Cloud for AWS system in a standalone configuration.

ontap_cloud_aws_standalone_delete

Removes an existing standalone ONTAP Cloud for AWS system.

ontap_cloud_aggregate

Creates a new ONTAP Cloud aggregate based on node attributes and settings.

Upload to Chef Server

This cookbook should be included in each organization of your CHEF environment. When importing, leverage Berkshelf:

berks upload

NOTE: use the --no-ssl-verify switch if the CHEF server in question has a self-signed SSL certificate.

berks upload --no-ssl-verify

Matchers/Helpers

Matchers

Note: Matchers should always be created in libraries/matchers.rb and used for validating calls to LWRP

Tests the LWRP (netapp_ontap_cloud_occm) with an action

setup_netapp_ontap_cloud_occm(resource_name)

Tests the LWRP (netapp_ontap_cloud_ontap_aws) with an action

create_netapp_ontap_cloud_ontap_aws(resource_name)
delete_netapp_ontap_cloud_ontap_aws(resource_name)

Tests the LWRP (netapp_ontap_cloud_aggregate) with an action

create_netapp_ontap_cloud_aggregate(resource_name)
delete_netapp_ontap_cloud_aggregate(resource_name)
add_netapp_ontap_cloud_aggregate(resource_name)

Helpers

Occm::Helper - A library of helper functions to interface with OnCommand Cloud Manager. This library can be included in recipes to perform commands and lookups of OCCM actions and resources.

Cookbook Testing

OnCommand Cloud Manager software

If you are testing locally, the installation media needs to be downloaded directly from NetApp's software download site. The media can be placed in files/default in this cookbook or hosted on a webserver. If hosted on the webserver, then the kitchen attribute installer needs to be set with the link.

Note: If Cloud Manager is provisioned locally, your OCCM server needs network connectivity to the cloud network where the ONTAP system is deployed. The process will run but ultimately fail to launch ONTAP Cloud without this connectivity.

Before you begin

Setup your testing and ensure all dependencies are installed. Open a terminal windows and execute:

gem install bundler
bundle install
berks install

Data_bags for Test-Kitchen

This cookbook requires the use of a data_bag for setting certain values. Local JSON version need to be stored in the directory structure as indicated below:

├── chef-repo/
│   ├── cookbooks
│   │   ├── netapp_ontap_cloud_occm
│   │   │   ├── .kitchen.yml
│   ├── data_bags
│   │   ├── data_bag_name
│   │   │   ├── data_bag_item.json

Note: Storing local testing versions of the data_bags at the root of your repo is considered best practice. This ensures that you only need to maintain a single copy while protecting the cookbook from being accientally committed with the data_bag. However, if you must change this location, then update the following key in the .kitchen.yml file.

data_bags_path: "../../data_bags/"

Rakefile and Tasks

This repo includes a Rakefile for common tasks

Task Command	Description
rake	Run Style, Foodcritic, Maintainers, and Unit Tests
rake style	Run all style checks
rake style:chef	Run Chef style checks
rake style:ruby	Run Ruby style checks
rake style:ruby:auto_correct	Auto-correct RuboCop offenses
rake unit	Run ChefSpec examples
rake integration	Run all kitchen suites
rake integration:kitchen:occm-centos-72	Run occm-centos-72 test instance
rake integration:kitchen:occm-web-install-72	Run occm-web-install-72 test instance
rake integration:kitchen:ontap-aws-centos-72	Run ontap-aws-centos-72 test instance
rake maintainers:generate	Generate MarkDown version of MAINTAINERS file

Chefspec and Test-Kitchen

bundle install: Installs and pulls all ruby gems dependencies from the Gemfile.
berks install: Installs all cookbook dependencies based on the Berksfile and the metadata.rb
rake: This will run all of the local tests - syntax, lint, unit, and maintainers file.
rake integration: This will run all of the kitchen tests

Test Cookbook (netapp_ontap_cloud_test):

a test cookbook for the available LWRPs

For the purposes of testing and validating this code, we have included a test cookbook with pre-configured recipes. The LWRP unit tests leverage these recipes to verify configuration.

Recipes

Name	Description
Default	Roll-up recipe to test all of the functionality of the LWRP-specific recipes
occm	Test the occm resource actions.
ontap_aws	Test the ontap_aws resource actions.
aggregate	Test the aggregate resource actions.

Compliance Profile

Included in this cookbook is a set of Inspec profile tests used for supported platforms in Test-Kitchen. These profiles can also be loaded into Chef Compliance to ensure on-going validation. The Control files are located at test/inspec/suite_name

Contribute

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

License & Authors

Author: Jeremy Goodrum (jeremy@exospheredata.com)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Name		Name	Last commit message	Last commit date
Latest commit History 24 Commits
.delivery		.delivery
attributes		attributes
libraries		libraries
recipes		recipes
resources		resources
spec		spec
tasks		tasks
test/smoke/occm		test/smoke/occm
.editorconfig		.editorconfig
.gitignore		.gitignore
.kitchen.yml		.kitchen.yml
.rubocop.yml		.rubocop.yml
Berksfile		Berksfile
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
Gemfile		Gemfile
LICENSE		LICENSE
MAINTAINERS.md		MAINTAINERS.md
README.md		README.md
Rakefile		Rakefile
chefignore		chefignore
metadata.rb		metadata.rb

License

exospheredata/netapp_ontap_cloud

Folders and files

Latest commit

History

Repository files navigation

NetApp OnCommand Cloud Manager and ONTAP Cloud

A cookbook to manage OCCM and ONTAP Cloud deployments

Requirements

Platforms

Chef

Cookbooks

Data bags

Amazon Web Services

OnCommand Cloud Manager for AWS Machine Image

ONTAP Cloud for AWS

Cloud Manager Admin credentials for AWS

Node Attributes

OnCommand Cloud Manager

ONTAP Cloud

Add Aggregate

Custom Resource

netapp_ontap_cloud_occm

Action :setup

Properties

Server Configuration properties

User Management properties

Tenant properties

AWS properties

Examples

Configure a minimal installation of Cloud Manager without AWS credentials

netapp_ontap_cloud_ontap_aws

Action :create

Properties

OnCommand Cloud Manager properties

Amazon Web Services properties

ONTAP Instance properties

Examples

Deploy ONTAP Cloud instance and wait for launch to complete

Action :set_write_speed

Properties

OnCommand Cloud Manager properties

Examples

Modify the write_speed of an existing ONTAP Cloud system

Action :delete

Properties

OnCommand Cloud Manager properties

Examples

Delete an existing ONTAP Cloud system

netapp_ontap_cloud_aggregate

Action :create

Properties

OnCommand Cloud Manager properties

ONTAP Instance properties

Examples

Add a new aggregate to an existing ONTAP Cloud system

Action :add

Properties

OnCommand Cloud Manager properties

ONTAP Instance properties

Examples

Add a new disk to an existing aggregate for the selected ONTAP Cloud system

Action :delete

Properties

OnCommand Cloud Manager properties

ONTAP Instance properties

Examples

Delete ONTAP Cloud instance and wait for completion

netapp_ontap_cloud_ndvp (deprecated)

Recipes

default

occm_install

occm_setup

ontap_cloud_aws_standalone

ontap_cloud_aws_standalone_delete

ontap_cloud_aggregate

Upload to Chef Server

Matchers/Helpers

Matchers

Helpers

Packages