Terraform is an open-source software tool to manage end to end lifecycle of your IT infrastructure. Terraform provides a consistent CLI workflow to manage hundreds of cloud services.
You can download the Terraform software from HashiCorp’s download page and use native installation methods for your operating system. Also you can install Terraform using the package managers like yum, apt, homebrew, Chocolatey (choco) etc. Refer install Terraform page for the appropriate method for your operating system.
\n",
"
Terraform CLI Cheat Sheet
\n",
"
Please note, this cheat sheet is a living document and I will make changes whenever there is an update or changes in the Terraform CLI options or versions. This cheat sheet does not written in an alphabetical order or based on workflow.
Theplan will check the configuration files (basically all the *.tf files in the directory) and will show you the items or changes going to made on target infrastructure or resources. Please note, this command will not actually perform the planned actions.
\n",
"
$ terraform plan
\n",
"
You can optionally save the plan to a file, which you can then pass to the apply command to perform exactly the actions described in the plan.
\n",
"
$ terraform plan -out plan.out
\n",
"
terraform get
\n",
"
Downloads and installs modules needed for the configuration given by PATH. get recursively downloads all modules needed, such as modules imported by modules imported by the root and so on. Module installation also happens automatically by default as part of the “terraform init” command, so you should rarely need to run this command separately.
\n",
"
$ terraform get
\n",
"
You can update the already downloaded modules using -update=true option.
\n",
"
$ terraform get -update=true
\n",
"
terraform apply
\n",
"
apply will do the actual operation on the infrastructure resources. apply will show the plan and actions in detail.
\n",
"
$ terraform apply
\n",
"
apply will ask for your confirmation to proceed with changes. You can use -auto-approve for auto-confirmation.
\n",
"
$ terraform apply -auto-approve
\n",
"
You can pass different variables or variable files.
\n",
"
$ terraform plan -var=\"instancetype=t2.small\"\n",
"$ terraform plan -var-file=\"custom.tfvars
\n",
"
You can use -target option to target specific resources, modules, or collections of resources.
terraform state has multiple subcommands to manage the terraform state. You can move, rm (delete), list or show the resource state.
\n",
"
Subcommands:\n",
" list List resources in the state\n",
" mv Move an item in the state\n",
" pull Pull current state and output to stdout\n",
" push Update remote state from a local state file\n",
" replace-provider Replace provider in the state\n",
" rm Remove instances from the state\n",
" show Show a resource in the state
\n",
"
Example usages
\n",
"
# List state\n",
"$ terraform state list\n",
"aws_iam_user.lb\n",
"aws_instance.myec2\n",
"\n",
"# Show resource\n",
"$ terraform state show aws_instance.myec2\n",
"\n",
"# Push terraform state to remote backend\n",
"$ tarraform state push\n",
"\n",
"# Pull the remote terraform state to a local copy\n",
"$ terraform state pull > terraform.tfstate\n",
"\n",
"# Update and tell terraform that packet_device.worker has been renamed to packet_device.helper\n",
"$ terraform state mv packet_device.worker packet_device.helper\n",
"\n",
"# Move the resource block into the child module configuration\n",
"$ terraform state mv packet_device.workermodule.worker.packet_device.worker\n",
"\n",
"# Remove the resource from state but it will not remove the resource from cloud/provider.\n",
"$ terraform state rm aws_instance.myec2
\n",
"
Remove the resource from state but it will not remove the resource from cloud/provider. But next time when you run terraform plan or apply, Terraform will recreate the instance as again as the resource definition is still there.
Rewrites all Terraform configuration files to a canonical format with appropriate indentation and styling. (JSON files (.tf.json or .tfvars.json) are not modified.)
\n",
"
$ terraform fmt
\n",
"
terraform taint
\n",
"
You can manually mark a terraform managed resource as tainted and forcing it to be destroyed and recreated on the next apply. terraform taint command will make modification in the tfstate file and recreate action will happen in next apply. Please note, terraform taint command will not modify the .tf file or the infrastructure.
\n",
"
$ terraform taint aws_instance.myec2
\n",
"
terraform import
\n",
"
You can import your existing infrastructure into Terraform and manage using Terraform.
\n",
"
# Importing VMWare VM to terraform\n",
"$ terraform import vsphere_virtual_machine.vm /DC1/vm/DEV/DEV2
Terraform Workspaces will help to manage same terraform configurations for different environments (eg: dev, staging, production) in the same project directory.
\n",
"
# Check the workspace\n",
"$ terraform workspace show\n",
"default\n",
"\n",
"# Create new workspace\n",
"$ terraform workspace new dev\n",
"Created and switched to workspace \"dev\"!\n",
"\n",
"# List all workspaces\n",
"$ terraform workspace list\n",
" default\n",
"* dev\n",
"\n",
"# Switch to a specific workspace\n",
"$ terraform workspace select dev\n",
"Switched to workspace \"dev\".
\n",
"
Terraform will create separate terraform.tfstate files in terraform.tfstate.d/WORKSPACE_NAME/ directories in the project directory.
You can use ${terraform.workspace} interpolation to dynamically use the workspace name inside your terraform configuration (*.tf). Eg: you can use it for selecting instance type from an array based on workspace.
Disclaimer: The views expressed and the content shared are those of the author and do not reflect the views of the author's employer or techbeatly platform.
Gineesh Mada Pparambath \n",
"Gineesh has worked as a Systems Engineer, Automation Specialist, and content author. His primary focus is on Ansible Automation, Containerisation (OpenShift & Kubernetes), and Infrastructure as Code (Terraform).\n",
"(aka Gini Gangadharan - iamgini.com)
Hey, Thank you dude for this usefull piece of information 🙂
\n",
"
Would you consider adding : \n",
"${terraform.workspace} variable inside your “terraform workspace” section ?
\n",
"
This variable is SOOO usefull, because you have multiples .tfstate … right … but you only have 1 .tf plan.
\n",
"
So you need sometimes to changes small things according to the workspace you’re in, right ? (I said small things, not the whole stack) \n",
"At least the name of the instances or the VPC you are connected to or others things like that.
Terraform is an open-source software tool to manage end to end lifecycle of your IT infrastructure. Terraform provides a consistent CLI workflow to manage hundreds of cloud services.
\n",
"
Latest Terraform Articles
\n",
"
Installing Terraform
\n",
"
You can download the Terraform software from HashiCorp’s download page and use native installation methods for your operating system. Also you can install Terraform using the package managers like yum, apt, homebrew, Chocolatey (choco) etc. Refer install Terraform page for the appropriate method for your operating system.
\n",
"
Terraform CLI Cheat Sheet
\n",
"
Please note, this cheat sheet is a living document and I will make changes whenever there is an update or changes in the Terraform CLI options or versions. This cheat sheet does not written in an alphabetical order or based on workflow.
Theplan will check the configuration files (basically all the *.tf files in the directory) and will show you the items or changes going to made on target infrastructure or resources. Please note, this command will not actually perform the planned actions.
\n",
"
$ terraform plan
\n",
"
You can optionally save the plan to a file, which you can then pass to the apply command to perform exactly the actions described in the plan.
\n",
"
$ terraform plan -out plan.out
\n",
"
terraform get
\n",
"
Downloads and installs modules needed for the configuration given by PATH. get recursively downloads all modules needed, such as modules imported by modules imported by the root and so on. Module installation also happens automatically by default as part of the “terraform init” command, so you should rarely need to run this command separately.
\n",
"
$ terraform get
\n",
"
You can update the already downloaded modules using -update=true option.
\n",
"
$ terraform get -update=true
\n",
"
terraform apply
\n",
"
apply will do the actual operation on the infrastructure resources. apply will show the plan and actions in detail.
\n",
"
$ terraform apply
\n",
"
apply will ask for your confirmation to proceed with changes. You can use -auto-approve for auto-confirmation.
\n",
"
$ terraform apply -auto-approve
\n",
"
You can pass different variables or variable files.
\n",
"
$ terraform plan -var=\"instancetype=t2.small\"\n",
"$ terraform plan -var-file=\"custom.tfvars
\n",
"
You can use -target option to target specific resources, modules, or collections of resources.
terraform state has multiple subcommands to manage the terraform state. You can move, rm (delete), list or show the resource state.
\n",
"
Subcommands:\n",
" list List resources in the state\n",
" mv Move an item in the state\n",
" pull Pull current state and output to stdout\n",
" push Update remote state from a local state file\n",
" replace-provider Replace provider in the state\n",
" rm Remove instances from the state\n",
" show Show a resource in the state
\n",
"
Example usages
\n",
"
# List state\n",
"$ terraform state list\n",
"aws_iam_user.lb\n",
"aws_instance.myec2\n",
"\n",
"# Show resource\n",
"$ terraform state show aws_instance.myec2\n",
"\n",
"# Push terraform state to remote backend\n",
"$ tarraform state push\n",
"\n",
"# Pull the remote terraform state to a local copy\n",
"$ terraform state pull > terraform.tfstate\n",
"\n",
"# Update and tell terraform that packet_device.worker has been renamed to packet_device.helper\n",
"$ terraform state mv packet_device.worker packet_device.helper\n",
"\n",
"# Move the resource block into the child module configuration\n",
"$ terraform state mv packet_device.workermodule.worker.packet_device.worker\n",
"\n",
"# Remove the resource from state but it will not remove the resource from cloud/provider.\n",
"$ terraform state rm aws_instance.myec2
\n",
"
Remove the resource from state but it will not remove the resource from cloud/provider. But next time when you run terraform plan or apply, Terraform will recreate the instance as again as the resource definition is still there.
Rewrites all Terraform configuration files to a canonical format with appropriate indentation and styling. (JSON files (.tf.json or .tfvars.json) are not modified.)
\n",
"
$ terraform fmt
\n",
"
terraform taint
\n",
"
You can manually mark a terraform managed resource as tainted and forcing it to be destroyed and recreated on the next apply. terraform taint command will make modification in the tfstate file and recreate action will happen in next apply. Please note, terraform taint command will not modify the .tf file or the infrastructure.
\n",
"
$ terraform taint aws_instance.myec2
\n",
"
terraform import
\n",
"
You can import your existing infrastructure into Terraform and manage using Terraform.
\n",
"
# Importing VMWare VM to terraform\n",
"$ terraform import vsphere_virtual_machine.vm /DC1/vm/DEV/DEV2
Terraform Workspaces will help to manage same terraform configurations for different environments (eg: dev, staging, production) in the same project directory.
\n",
"
# Check the workspace\n",
"$ terraform workspace show\n",
"default\n",
"\n",
"# Create new workspace\n",
"$ terraform workspace new dev\n",
"Created and switched to workspace \"dev\"!\n",
"\n",
"# List all workspaces\n",
"$ terraform workspace list\n",
" default\n",
"* dev\n",
"\n",
"# Switch to a specific workspace\n",
"$ terraform workspace select dev\n",
"Switched to workspace \"dev\".
\n",
"
Terraform will create separate terraform.tfstate files in terraform.tfstate.d/WORKSPACE_NAME/ directories in the project directory.
You can use ${terraform.workspace} interpolation to dynamically use the workspace name inside your terraform configuration (*.tf). Eg: you can use it for selecting instance type from an array based on workspace.
if no value mentioned, then default value will be used.
if default value not defined, then terraform will ask for variable when you do apply or plan operation.
Resources
\n",
"
Share this to your network:
\n",
"
\n",
"
Related
\n",
"\n",
"
\n",
"
\n"
]
}
],
"source": [
"import requests\n",
"from readability import Document\n",
"\n",
"response = requests.get(\"https://www.techbeatly.com/terraform-cheat-sheet\")\n",
"doc = Document(response.text)\n",
"print(doc.title())\n",
"\n",
"print(doc.summary())"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Create Book if it doesn't exist\n"
]
},
{
"cell_type": "code",
"execution_count": 29,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"{\"name\":\"python-cheatsheet\",\"description\":\"python-cheatsheet\",\"created_by\":1,\"updated_by\":1,\"owned_by\":1,\"slug\":\"python-cheatsheet\",\"updated_at\":\"2022-08-10T00:14:32.000000Z\",\"created_at\":\"2022-08-10T00:14:32.000000Z\",\"id\":3}\n"
]
}
],
"source": [
"import requests\n",
"\n",
"import os\n",
"\n",
"payload = {\n",
" \"name\": \"terraform-cheatsheet\",\n",
" \"description\": \"terraform-cheatsheet\",\n",
" \"tags\": [\n",
" {\"name\": \"Platform\", \"value\": \"terraform\"},\n",
" {\"name\": \"Category\", \"value\": \"Code\"},\n",
" {\"name\": \"Type\", \"value\": \"Cheatsheet\"},\n",
" ],\n",
"}\n",
"headers = {\n",
" \"X-API-KEY\": os.getenv(X_API_KEY),\n",
" \"Authorization\": os.getenv(BOOKSTACK_API_TOKEN),\n",
"}\n",
"\n",
"response = requests.request(\"POST\", url, json=payload, headers=headers)\n",
"\n",
"print(response.text)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Create Chapters\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### List folders to map to chapters\n"
]
},
{
"cell_type": "code",
"execution_count": 23,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"18\n",
"19\n",
"20\n"
]
}
],
"source": [
"import requests\n",
"\n",
"chapters = [\"cheatsheet\", \"modules\", \"builtin\"]\n",
"\n",
"url = \"https://donavanaldrich.com/api/bookstack/chapters\"\n",
"\n",
"for chapter_name in chapters:\n",
"\n",
" payload = {\n",
" \"book_id\": 2,\n",
" \"name\": chapter_name,\n",
" \"description\": chapter_name,\n",
" \"tags\": [{\"name\": \"chapter\", \"value\": chapter_name}],\n",
" }\n",
" headers = {\n",
" \"X-API-KEY\": os.getenv(X_API_KEY),\n",
" \"Authorization\": os.getenv(BOOKSTACK_API_TOKEN),\n",
" }\n",
"\n",
" response = requests.request(\"POST\", url, json=payload, headers=headers)\n",
" response_json = response.json()\n",
" chapter_id = response_json[\"id\"]\n",
" print(chapter_id)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Add Pages\n"
]
},
{
"cell_type": "code",
"execution_count": 32,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"26\n",
"27\n",
"28\n"
]
}
],
"source": [
"from pathlib import Path\n",
"import requests\n",
"import frontmatter\n",
"\n",
"chapters = [\"cheatsheet\", \"modules\", \"builtin\"]\n",
"# The Python interpreter has a number of functions and types built into it that are always available.\n",
"# Standard Library\n",
"headers = {\n",
" \"X-API-KEY\": os.getenv(X_API_KEY),\n",
" \"Authorization\": os.getenv(BOOKSTACK_API_TOKEN),\n",
"}\n",
"\n",
"url = \"https://donavanaldrich.com/api/bookstack/books\"\n",
"\n",
"payload = {\n",
" \"name\": \"python-cheatsheet\",\n",
" \"description\": \"python-cheatsheet\",\n",
" \"tags\": [\n",
" {\"name\": \"Platform\", \"value\": \"Python\"},\n",
" {\"name\": \"Category\", \"value\": \"Code\"},\n",
" {\"name\": \"Type\", \"value\": \"Cheatsheet\"},\n",
" ],\n",
"}\n",
"\n",
"response = requests.request(\"POST\", url, json=payload, headers=headers)\n",
"response_json = response.json()\n",
"book_id = response_json[\"id\"]\n",
"\n",
"# book_id = xs\n",
"#\n",
"for chapter in chapters:\n",
" payload = {\n",
" \"book_id\": book_id,\n",
" \"name\": chapter,\n",
" \"description\": chapter,\n",
" \"tags\": [{\"name\": \"chapter\", \"value\": chapter}],\n",
" }\n",
" url = \"https://donavanaldrich.com/api/bookstack/chapters\"\n",
" response = requests.request(\"POST\", url, json=payload, headers=headers)\n",
" response_json = response.json()\n",
" chapter_id = response_json[\"id\"]\n",
" print(chapter_id)\n",
"\n",
" for page in Path(\"../temp/python-cheatsheets/\" + chapter).iterdir():\n",
" url = \"https://donavanaldrich.com/api/bookstack/pages\"\n",
" with open(page, \"r\") as f:\n",
" # text = f.read()\n",
" # post = frontmatter.load(page)\n",
" metadata, content = frontmatter.parse(f.read())\n",
" try:\n",
" page_name = metadata[\"title\"]\n",
" except:\n",
" page_name = str(page)\n",
" payload = {\n",
" \"book_id\": book_id,\n",
" \"chapter_id\": chapter_id,\n",
" \"name\": page_name,\n",
" \"markdown\": content,\n",
" \"tags\": [{\"name\": \"chapter\", \"value\": chapter}],\n",
" }\n",
" response = requests.request(\"POST\", url, json=payload, headers=headers)\n",
"\n",
" # print(response.text)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Development/Sandboxing\n"
]
},
{
"cell_type": "code",
"execution_count": 28,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"# Python Debugging\n",
"\n",
"\n",
" \n",
" Finding and resolving bugs\n",
" \n",
" \n",
" In computer programming and software development, debugging is the process of finding and resolving bugs (defects or problems that prevent correct operation) within computer programs, software, or systems.\n",
" \n",
"\n",
"\n",
"## Raising Exceptions\n",
"\n",
"Exceptions are raised with a raise statement. In code, a raise statement consists of the following:\n",
"\n",
"- The `raise` keyword\n",
"- A call to the `Exception()` function\n",
"- A string with a helpful error message passed to the `Exception()` function\n",
"\n",
"```python\n",
">>> raise Exception('This is the error message.')\n",
"# Traceback (most recent call last):\n",
"# File \"\", line 1, in \n",
"# raise Exception('This is the error message.')\n",
"# Exception: This is the error message.\n",
"```\n",
"\n",
"Typically, it’s the code that calls the function, not the function itself, that knows how to handle an exception. So, you will commonly see a raise statement inside a function and the `try` and `except` statements in the code calling the function.\n",
"\n",
"```python\n",
">>> def box_print(symbol, width, height):\n",
"... if len(symbol) != 1:\n",
"... raise Exception('Symbol must be a single character string.')\n",
"... if width <= 2:\n",
"... raise Exception('Width must be greater than 2.')\n",
"... if height <= 2:\n",
"... raise Exception('Height must be greater than 2.')\n",
"... print(symbol * width)\n",
"... for i in range(height - 2):\n",
"... print(symbol + (' ' * (width - 2)) + symbol)\n",
"... print(symbol * width)\n",
"...\n",
">>> for sym, w, h in (('*', 4, 4), ('O', 20, 5), ('x', 1, 3), ('ZZ', 3, 3)):\n",
"... try:\n",
"... box_print(sym, w, h)\n",
"... except Exception as err:\n",
"... print('An exception happened: ' + str(err))\n",
"...\n",
"# ****\n",
"# * *\n",
"# * *\n",
"# ****\n",
"# OOOOOOOOOOOOOOOOOOOO\n",
"# O O\n",
"# O O\n",
"# O O\n",
"# OOOOOOOOOOOOOOOOOOOO\n",
"# An exception happened: Width must be greater than 2.\n",
"# An exception happened: Symbol must be a single character string.\n",
"```\n",
"\n",
"Read more about [Exception Handling](/cheatsheet/exception-handling).\n",
"\n",
"## Getting the Traceback as a string\n",
"\n",
"The `traceback` is displayed by Python whenever a raised exception goes unhandled. But can also obtain it as a string by calling traceback.format_exc(). This function is useful if you want the information from an exception’s traceback but also want an except statement to gracefully handle the exception. You will need to import Python’s traceback module before calling this function.\n",
"\n",
"```python\n",
">>> import traceback\n",
"\n",
">>> try:\n",
"... raise Exception('This is the error message.')\n",
">>> except:\n",
"... with open('errorInfo.txt', 'w') as error_file:\n",
"... error_file.write(traceback.format_exc())\n",
"... print('The traceback info was written to errorInfo.txt.')\n",
"...\n",
"# 116\n",
"# The traceback info was written to errorInfo.txt.\n",
"```\n",
"\n",
"The 116 is the return value from the `write()` method, since 116 characters were written to the file. The `traceback` text was written to errorInfo.txt.\n",
"\n",
" Traceback (most recent call last):\n",
" File \"\", line 2, in \n",
" Exception: This is the error message.\n",
"\n",
"## Assertions\n",
"\n",
"An assertion is a sanity check to make sure your code isn’t doing something obviously wrong. These sanity checks are performed by `assert` statements. If the sanity check fails, then an `AssertionError` exception is raised. In code, an `assert` statement consists of the following:\n",
"\n",
"- The `assert` keyword\n",
"- A condition (that is, an expression that evaluates to `True` or `False`)\n",
"- A comma\n",
"- A `string` to display when the condition is `False`\n",
"\n",
"```python\n",
">>> pod_bay_door_status = 'open'\n",
">>> assert pod_bay_door_status == 'open', 'The pod bay doors need to be \"open\".'\n",
"\n",
">>> pod_bay_door_status = 'I\\'m sorry, Dave. I\\'m afraid I can\\'t do that.'\n",
">>> assert pod_bay_door_status == 'open', 'The pod bay doors need to be \"open\".'\n",
"# Traceback (most recent call last):\n",
"# File \"\", line 1, in \n",
"# assert pod_bay_door_status == 'open', 'The pod bay doors need to be \"open\".'\n",
"# AssertionError: The pod bay doors need to be \"open\".\n",
"```\n",
"\n",
"In plain English, an assert statement says, “I assert that this condition holds true, and if not, there is a bug somewhere in the program.” Unlike exceptions, your code should not handle assert statements with try and except; if an assert fails, your program should crash. By failing fast like this, you shorten the time between the original cause of the bug and when you first notice the bug. This will reduce the amount of code you will have to check before finding the code that’s causing the bug.\n",
"\n",
"### Disabling Assertions\n",
"\n",
"Assertions can be disabled by passing the `-O` option when running Python.\n",
"\n",
"## Logging\n",
"\n",
"To enable the `logging` module to display log messages on your screen as your program runs, copy the following to the top of your program:\n",
"\n",
"```python\n",
">>> import logging\n",
">>> logging.basicConfig(level=logging.DEBUG, format=' %(asctime)s - %(levelname)s- %(message)s')\n",
"```\n",
"\n",
"Say you wrote a function to calculate the factorial of a number. In mathematics, factorial 4 is 1 × 2 × 3 × 4, or 24. Factorial 7 is 1 × 2 × 3 × 4 × 5 × 6 × 7, or 5,040. Open a new file editor window and enter the following code. It has a bug in it, but you will also enter several log messages to help yourself figure out what is going wrong. Save the program as factorialLog.py.\n",
"\n",
"```python\n",
">>> import logging\n",
">>> logging.basicConfig(level=logging.DEBUG, format=' %(asctime)s - %(levelname)s- %(message)s')\n",
">>> logging.debug('Start of program')\n",
"\n",
">>> def factorial(n):\n",
"... logging.debug('Start of factorial(%s)' % (n))\n",
"... total = 1\n",
"... for i in range(1, n + 1):\n",
"... total *= i\n",
"... logging.debug('i is ' + str(i) + ', total is ' + str(total))\n",
"... logging.debug('End of factorial(%s)' % (n))\n",
"... return total\n",
"...\n",
">>> print(factorial(5))\n",
">>> logging.debug('End of program')\n",
"# 2015-05-23 16:20:12,664 - DEBUG - Start of program\n",
"# 2015-05-23 16:20:12,664 - DEBUG - Start of factorial(5)\n",
"# 2015-05-23 16:20:12,665 - DEBUG - i is 0, total is 0\n",
"# 2015-05-23 16:20:12,668 - DEBUG - i is 1, total is 0\n",
"# 2015-05-23 16:20:12,670 - DEBUG - i is 2, total is 0\n",
"# 2015-05-23 16:20:12,673 - DEBUG - i is 3, total is 0\n",
"# 2015-05-23 16:20:12,675 - DEBUG - i is 4, total is 0\n",
"# 2015-05-23 16:20:12,678 - DEBUG - i is 5, total is 0\n",
"# 2015-05-23 16:20:12,680 - DEBUG - End of factorial(5)\n",
"# 0\n",
"# 2015-05-23 16:20:12,684 - DEBUG - End of program\n",
"```\n",
"\n",
"## Logging Levels\n",
"\n",
"Logging levels provide a way to categorize your log messages by importance. There are five logging levels, described in Table 10-1 from least to most important. Messages can be logged at each level using a different logging function.\n",
"\n",
"| Level | Logging Function | Description |\n",
"| ---------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n",
"| `DEBUG` | `logging.debug()` | The lowest level. Used for small details. Usually you care about these messages only when diagnosing problems. |\n",
"| `INFO` | `logging.info()` | Used to record information on general events in your program or confirm that things are working at their point in the program. |\n",
"| `WARNING` | `logging.warning()` | Used to indicate a potential problem that doesn’t prevent the program from working but might do so in the future. |\n",
"| `ERROR` | `logging.error()` | Used to record an error that caused the program to fail to do something. |\n",
"| `CRITICAL` | `logging.critical()` | The highest level. Used to indicate a fatal error that has caused or is about to cause the program to stop running entirely. |\n",
"\n",
"## Disabling Logging\n",
"\n",
"After you’ve debugged your program, you probably don’t want all these log messages cluttering the screen. The logging.disable() function disables these so that you don’t have to go into your program and remove all the logging calls by hand.\n",
"\n",
"```python\n",
">>> import logging\n",
"\n",
">>> logging.basicConfig(level=logging.INFO, format=' %(asctime)s -%(levelname)s - %(message)s')\n",
">>> logging.critical('Critical error! Critical error!')\n",
"# 2015-05-22 11:10:48,054 - CRITICAL - Critical error! Critical error!\n",
"\n",
">>> logging.disable(logging.CRITICAL)\n",
">>> logging.critical('Critical error! Critical error!')\n",
">>> logging.error('Error! Error!')\n",
"```\n",
"\n",
"## Logging to a File\n",
"\n",
"Instead of displaying the log messages to the screen, you can write them to a text file. The `logging.basicConfig()` function takes a filename keyword argument, like so:\n",
"\n",
"```python\n",
">>> import logging\n",
">>> logging.basicConfig(filename='myProgramLog.txt', level=logging.DEBUG, format='%(asctime)s - %(levelname)s - %(message)s')\n",
"```\n"
]
}
],
"source": [
"# for page in Path('../temp/python-cheatsheets/' + chapter).iterdir():\n",
"page = \"../temp/python-cheatsheets/cheatsheet/debugging.md\"\n",
"url = \"https://donavanaldrich.com/api/bookstack/pages\"\n",
"# print(page)\n",
"with open(page, \"r\") as f:\n",
" # text = f.read()\n",
" # post = frontmatter.load(page)\n",
" metadata, content = frontmatter.parse(f.read())\n",
"print(content)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Reference\n",
"\n",
"### Payloads\n",
"\n",
"#### book\n",
"\n",
"```json\n",
"{\n",
" \"name\": \"python-cheatsheet\",\n",
" \"description\": \"python-cheatsheet\",\n",
" \"tags\": [\n",
" { \"name\": \"Platform\", \"value\": \"Python\" },\n",
" { \"name\": \"Category\", \"value\": \"Code\" },\n",
" { \"name\": \"Type\", \"value\": \"Cheatsheet\" }\n",
" ]\n",
"}\n",
"```\n",
"\n",
"#### Chapter\n",
"\n",
"```json\n",
"{\n",
" \"book_id\": 1,\n",
" \"name\": \"My fantastic new chapter\",\n",
" \"description\": \"This is a great new chapter that I've created via the API\",\n",
" \"tags\": [\n",
" { \"name\": \"Category\", \"value\": \"Top Content\" },\n",
" { \"name\": \"Rating\", \"value\": \"Highest\" }\n",
" ]\n",
"}\n",
"```\n",
"\n",
"#### Page\n",
"\n",
"```json\n",
"{\n",
" \"book_id\": 1,\n",
" \"name\": \"My API Page\",\n",
" \"markdown\": \"
![\"\"](\"https://www.techbeatly.com/wp-content/uploads/2021/11/terraform-cheat-sheet-techbeatly-new-1024x576.png\")
![\"\"](\"https://www.techbeatly.com/wp-content/uploads/2022/08/ansible-automation-controller-ad-hoc-commands-768x432.png\")
\n",
"![\"\"](\"https://www.techbeatly.com/wp-content/uploads/2021/09/techbeatly-logo-v4.1-black.png\")
![\"\"](\"data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7\")
![\"\"](\"https://www.techbeatly.com/wp-content/uploads/2021/11/terraform-installation-methods.png\")
![\"\"](\"https://www.techbeatly.com/wp-content/uploads/2022/06/pexels-christina-morillo-1181472-coding-768x513.jpg\")
\n",
"![\"\"](\"https://www.techbeatly.com/wp-content/uploads/2022/05/pexels-realtoughcandycom-11035393_1920-768x512.jpg\")
\n",
"![\"\"](\"https://www.techbeatly.com/wp-content/uploads/2022/05/annie-spratt-hCb3lIB8L8E-unsplash-devops-mistakes-chatty-768x504.jpg\")
\n",
"![\"\"](\"https://www.techbeatly.com/wp-content/uploads/2022/05/best-tools-for-vm-backup-to-prevent-anybrservice-interruption-or-severe-financial-loss-768x480.png\")
\n",
"![\"\"](\"https://www.techbeatly.com/wp-content/uploads/2022/04/john-schnobrich-FlPc9_VocJ4-unsplash-768x512.jpg\")
\n",
"
\n", "- \n",
"
\n",
"\n",
"Terraform Cheat Sheet – techbeatly - Mambot says: \n",
"\n",
"November 25, 2021 at 4:10 am \n",
"\n",
"Loading... \n",
" \n",
" \n",
" \n",
"- \n",
"
\n",
"\n",
"
alexis says: \n",
"\n",
"November 25, 2021 at 5:38 pm \n",
" \n",
" \n",
"- \n",
"
\n",
"\n",
"
Vergnaud Damien says: \n",
"\n",
"November 26, 2021 at 11:16 pm \n",
"\n",
"Loading... \n",
" \n",
" \n",
" \n",
"- \n",
"
\n",
"\n",
"
Vaishnavi says: \n",
"\n",
"February 6, 2022 at 3:25 pm \n",
"\n",
"Loading... \n",
" \n",
" \n",
" \n",
"- \n",
"
\n",
"\n",
"10 Free Courses to Learn Terraform – techbeatly says: \n",
"\n",
"February 24, 2022 at 8:53 pm \n",
"\n",
"Loading... \n",
" \n",
" \n",
" \n",
"
\n", "[…] https://www.techbeatly.com/terraform-cheat-sheet/ […]
\n", "\n", "- \n",
"
\n",
"\n",
"
Gineesh Madapparambath says: \n",
"\n",
"November 27, 2021 at 4:28 pm \n",
"\n",
"Loading... \n",
" \n",
" \n",
" \n",
"
\n", "Thank you
\n", "Hey, Thank you dude for this usefull piece of information 🙂
\n", "Would you consider adding :
\n", "\n", "${terraform.workspace} variable inside your “terraform workspace” section ?
This variable is SOOO usefull, because you have multiples .tfstate … right … but you only have 1 .tf plan.
\n", "So you need sometimes to changes small things according to the workspace you’re in, right ? (I said small things, not the whole stack)
\n", "\n", "At least the name of the instances or the VPC you are connected to or others things like that.
I recommand you to make a small mention of it if you share my though 🙂
\n", "\n", "https://www.terraform.io/docs/language/state/workspaces.html
Have a great day 🙂
\n", "\n", "- \n",
"
\n",
"\n",
"
Gineesh Madapparambath says: \n",
"\n",
"November 27, 2021 at 4:27 pm \n",
"\n",
"Loading... \n",
" \n",
" \n",
" \n",
"
\n", "Thank you so much Damien,
\n", "\n", "Appreciate your suggestion and feedback. I have added the same under Workspace section.
thanks for the great article!!
\n", "[…] Terraform? Check this Terraform cheat sheet for quick […]
\n", "