Skip to content

Latest commit

 

History

History
265 lines (196 loc) · 8.4 KB

README.md

File metadata and controls

265 lines (196 loc) · 8.4 KB
Raw

Intersight IaC Wizard

published

Updates/News - Archiving Repository

11-18-2023

  • Renaming repository to make it more relevant to all the use cases covered
  • New Repository intersight-tools
  • Please start using new repository

11-30-2022

  • Changing Script output from HCL to YAML
  • Remove requirements for Go Compiler
  • Remove requirements for the HCL2JSON Tool - No longer utilized
  • Added Support for Importing Existing YAML Files to be consumed by Script
  • Added FC Zone Policy

09-11-2022

  • Renamed main.py to ezimm.py to allow execution from remote directory

03-08-2022

  • Added Windows Support

  • IMPORTANT - There is currently a bug with Policy Buckets for UCS Domain Profiles. That is the only reason ucs_domain_profiles are not in the same folder as chassis and servers. When this is fixed the ucs_domain_profiles folder will be merged with the profiles folder. Because of this limitation at this time make sure to create a seperate policy for Domains of the following types:

  • network_connectivity_policies - If Using Standalone Server Policies
  • ntp_policies - If Using Standalone Server Policies
  • snmp_policies
  • syslog_policies

Getting Started

Install Visual Studio Code

  • Download Here: Visual Studio Code

  • Recommended Extensions:

    • GitHub Pull Requests and Issues - Author GitHub
    • HashiCorp Terraform - Author HashiCorp
    • Pylance - Author Microsoft
    • Python - Author Microsoft
    • PowerShell (Windows) - Author Microsoft

  • Authorize Visual Studio Code to GitHub via the GitHub Extension

Install git

  • Linux - Use the System Package Manager - apt/yum etc.
sudo apt update
sudo apt install git
  • Windows Download Here: Git

configure Git Credentials

git config --global user.name "<username>"   
git config --global user.email "<email>"

Python Requirements

  • Python 3.6 or Greater
  • Linux - Use the System Package Manager - apt/yum etc.
  • Windows Download Here: Python Note: Make sure to select the Add To System Path Option during the installation
  • For Windows. Make sure python.exe and pip.exe are available via the system path.
  • Windows Example (The Folder Python310 would be according to the Python Release) - Administrator Session

Clone this Repository

git clone https://github.com/scotttyso/intersight_iac
cd intersight_iac
  • Install the Requirements File
$ pip install -r requirements.txt

Terraform Requirements

The script utilizes features introduced in 1.3.0 of Terraform. So we need 1.3.0 or preferrably >1.3.0

  • Download Here terraform
  • For Windows Make sure it is in a Directory that is in the system path.

Terraform Modules and Providers

This script will utilize the Intersight Terraform Provider and two modules built off of the Intersight Provider.

Running the Wizard

  • It is recommend to add the following secure variables to your environment before running the script

  • Linux

## Intersight Variables
export TF_VAR_apikey="<your_intersight_api_key>"
export TF_VAR_secretkey=`cat ~/Downloads/SecretKey.txt` 
# The above example is based on the key being in your Downloads folder.  Correct for your environment.

## Terraform Cloud Variables
export TF_VAR_terraform_cloud_token="<your_terraform_cloud_token>"
  • Windows - Plugin your API Keys and the File Location of the Intersight Secret Key.
## Powershell Intersight Variables
$env:TF_VAR_apikey="<your_intersight_api_key>"
$env:TF_VAR_secretkey="$HOME\Downloads\SecretKey.txt"
# The above example is based on the key being in your Downloads folder.  Correct for your environment.

## Powershell Terraform Cloud Variables
$env:TF_VAR_terraform_cloud_token="<your_terraform_cloud_token>"

Running the Wizard for Brownfield Migration with the IMM Transition Tool

  • Running the wizard to use a configuration migrated from UCS Manager using the IMM Transition Tool
./ezimm.py -j {json_file_name.json}

Running the Wizard for Greenfield Deployment

  • Running the Wizard to generate IaC through a Question and Answer Wizard
./ezimm.py

Wizard Help Menu

./ezimm.py -h

Intersight Easy IMM Deployment Module

optional arguments:
  -h, --help            show this help message and exit
  -a API_KEY_ID, --api-key-id API_KEY_ID
                        The Intersight API client key id for HTTP signature scheme
  -s API_KEY_FILE, --api-key-file API_KEY_FILE
                        Name of file containing The Intersight secret key for the HTTP signature scheme
  --api-key-v3          Use New API client (v3) key
  -d DIR, --dir DIR     The Directory to Publish the Terraform Files to.
  -i, --ignore-tls      Ignore TLS server-side certificate verification
  -j JSON_FILE, --json_file JSON_FILE
                        The IMM Transition Tool JSON Dump File to Convert to HCL.
  -u URL, --url URL     The Intersight root URL for the API endpoint. The default is https://intersight.com

Terraform Plan and Apply

After the Script has generated the Repository and downloaded the resources from the Easy IMM Comprehensive Example, the data will need to be pushed to Intersight using Terraform Cloud.

Disclaimer

This code is provided as is. No warranty, support, or guarantee is provided with this. But in typical github fashion there is the opportunity to collaborate and share Bug's/Feedback/PR Requests.

Synopsis

The purpose of this Python Tool is to deploy Policy/Profiles to Intersight using Infastructure as Code with Terraform. The Wizard is a step for users to create and better understand how to utilize Terraform for managing infrastrudture.

The goal of this module is to begin to familiarize you with Terraform through the following steps:

  1. Begin to familiarize users with Terraform format and variable creation.
  2. Once a user feels conformatable with the auto generated files, Transition towards writing your own modules to consume.
  3. And lastly build your confidence to write your own code as well.

The wizard will show after each section what the YAML Data being generated will look like. In the Heading for each section it will point you to the directly and file where the code will be created. And lastly, publish the code to Terraform Cloud and when you are ready.

Use Cases

  • Create Pools
  • Create Policies
  • Create UCS Domain Profiles and attach Fabric Interconnects to the profiles
  • Create Service Profiles and Templates and deploy physical infrastructure

Intersight Pools

This set of modules support creating the following Pool Types:

  • IP Pools
  • IQN Pools
  • MAC Pools
  • Resource Pools
  • UUID Pools
  • WWNN Pools
  • WWPN Pools

Intersight Policies

This set of modules support creating the following Policy Types:

  • Adapter Configuration
  • BIOS
  • Boot Order
  • Certificate Management
  • Device Connector
  • Ethernet Adapter
  • Ethernet Network
  • Ethernet Network Control
  • Ethernet Network Group
  • Ethernet QoS
  • FC Zone
  • Fibre Channel Adapter
  • Fibre Channel Network
  • Fibre Channel QoS
  • IMC Access
  • Flow Control
  • IPMI Over LAN
  • iSCSI Adapter
  • iSCSI Boot
  • iSCSI Static Target
  • LAN Connectivity
  • LDAP
  • Link Aggregation
  • Link Control
  • Local User
  • Multicast
  • Network Connectivity
  • NTP
  • Persistent Memory
  • Port
  • Power
  • SAN Connectivity
  • SD Card
  • Serial over LAN
  • SMTP
  • SNMP
  • SSH
  • Storage
  • Switch Control
  • Syslog
  • System QoS
  • Thermal
  • Virtual KVM
  • Virtual Media
  • VLAN
  • VSAN

Intersight Profiles and Templates

This set of modules support creating the following Profile Types:

  • UCS Chassis Profile(s)
  • UCS Domain Profile(s)
  • UCS Server Profile(s)
  • UCS Server Template - Important Note. The script only uses Server Templates for holding policies. This allows for flexibility around allowing the script to override policies by assigning unique policies to servers that is not supported by standard templates.

To sum this up... the goal is to deploy the infrastructure using Terraform through an easy to consume wizard.

Resources