{"id":65051,"date":"2022-06-13T09:00:33","date_gmt":"2022-06-13T09:00:33","guid":{"rendered":"https:\/\/www.cryptocabaret.com\/?p=65051"},"modified":"2022-06-13T09:00:33","modified_gmt":"2022-06-13T09:00:33","slug":"use-terraform-to-manage-truenas","status":"publish","type":"post","link":"https:\/\/www.cryptocabaret.com\/?p=65051","title":{"rendered":"Use Terraform to manage TrueNAS"},"content":{"rendered":"

Use Terraform to manage TrueNAS<\/span>
\nAlan Formy-Duval<\/a><\/span>
\nMon, 06\/13\/2022 – 03:00<\/span><\/p>\n

\n
Register<\/a> or Login<\/a> to like<\/div>\n
Register<\/a> or Login<\/a> to like<\/div>\n<\/div>\n
\n

Sometimes combining different open source projects can have benefits. The synergy of using Terraform with TrueNAS is a perfect example.<\/p>\n

TrueNAS is an OpenBSD-based operating system that provides network-attached storage (NAS) and network services. One of its main strengths is leveraging the ZFS file system, which is known for enterprise-level reliability and fault tolerance. Terraform is a provisioning and deployment tool embodying the concept of infrastructure as code.<\/p>\n

TrueNAS<\/b><\/h2>\n

TrueNAS has a very nice web user interface (UI) for its management and an application programming interface (API). Terraform can be integrated with the API to provide configuration management of your NAS, as I’ll demonstrate below.<\/p>\n

To begin, I used Virtual Machine Manager to configure a virtual machine and then installed the latest version, TrueNAS 13.0. The only necessary input was to enter the root password. Once it reboots, the main menu appears. You will also see the HTTP management address. You can access this address from your local web browser.<\/p>\n

\n
\"Virtual<\/div>\n
Image by: <\/span><\/p>\n

(Alan Formy-Duval, CC BY-SA 4.0)<\/p>\n<\/div>\n<\/article>\n

Terraform<\/h2>\n

Terraform needs to be installed where it can access the TrueNAS management URL. I am taking advantage of tfenv<\/i>, a tool for managing Terraform versions.<\/p>\n

\n$ tfenv list-remote\n$ tfenv install 1.2.0\n$ tfenv use 1.2.0\n$ terraform -version\nTerraform v1.2.0\non linux_amd64<\/code><\/pre>\n
Next, create a working directory, such as ~\/code\/terraform\/truenas<\/code>, to contain the configuration files associated with your TrueNAS instance.<\/p>\n
\n
$ mkdir<\/span> ~\/<\/span>code\/<\/span>terraform\/<\/span>truenas
\n$ cd<\/span> ~\/<\/span>code\/<\/span>terraform\/<\/span>truenas<\/div><\/div><\/pre>\n
Create the initial terraform configuration file and add the necessary directives to define the TrueNAS provider.<\/p>\n
\n$ <\/span>vi<\/span> main.tf<\/code><\/span><\/pre>\n
The provider will look like this, where the address and API key for your TrueNAS instance will need to be correctly specified.<\/p>\n
\n
$ cat<\/span> main.tf


\nterraform {<\/span>
\n\u00a0 required_providers {<\/span>
\n\u00a0 \u00a0 truenas = {<\/span>
\n\u00a0 \u00a0 \u00a0 source<\/span> = \"dariusbakunas\/truenas\"<\/span>
\n\u00a0 \u00a0 \u00a0 version = \"0.9.0\"<\/span>
\n\u00a0 \u00a0 }<\/span>
\n\u00a0 }<\/span>
}<\/span>

\nprovider \"truenas\"<\/span> {<\/span>
\n\u00a0 api_key = \"1-61pQpp3WyfYwg4dHToTHcOt7QQzVrMtZnkJAe9mmA0Z2w5MJsDB7Bng5ofZ3bbyn\"<\/span>
\n\u00a0 base_url = \"http:\/\/192.168.122.139\/api\/v2.0\"<\/span>
}<\/span><\/div><\/div><\/pre>\n
The TrueNAS API key is created in the Web UI. Log in and click the small gear in the upper right-hand corner.<\/p>\n
\n
  \"A<\/div>\n
Image by: <\/span><\/p>\n
(Alan Formy-Duval, CC BY-SA 4.0)<\/p>\n<\/div>\n<\/article>\n
This UI section enables you to create the API key. Once generated, copy it to the main.tf<\/code> file.<\/p>\n
Initialize<\/h2>\n
In your TrueNAS Terraform directory, you have the main.tf<\/code> file. The first step is to initialize using the command terraform init<\/code>, which should generate the following result:<\/p>\n
\n
Initializing the backend...

\nInitializing provider plugins...
\n- Finding dariusbakunas\/<\/span>truenas versions matching \"0.9.0\"<\/span>...
\n- Installing dariusbakunas\/<\/span>truenas v0.9.0...
\n- Installed dariusbakunas\/<\/span>truenas v0.9.0 (<\/span>self-signed, key ID E44AF1CA58555E96)<\/span>

\nPartner and community providers are signed by their developers.
\nIf you'd like to know more about provider signing, you can read about it here:
\nhttps:\/\/www.terraform.io\/docs\/cli\/plugins\/signing.html

\nTerraform has created a lock file .terraform.lock.hcl to record the provider
\nselections it made above. Include this file in your version control repository
\nso that Terraform can guarantee to make the same selections by default when
\nyou run \"terraform init\" in the future.

\nTerraform has been successfully initialized!

\nYou may now begin working with Terraform. Try running \"terraform plan\" to see
\nany changes that are required for your infrastructure. All Terraform commands
\nshould now work.

\nIf you ever set or change modules or backend configuration for Terraform,
\nrerun this command to reinitialize your working directory. If you forget, other commands will detect it and remind you to do so if necessary.<\/span><\/div><\/div><\/pre>\n
A successful initialization means you’re ready to start adding resources. Any TrueNAS item, such as a storage pool, network file system (NFS) share, or cron job, is a resource.<\/p>\n<\/p>\n
\n
Linux Containers<\/div>\n
\n
What are Linux containers?<\/a><\/div>\n
What is Kubernetes?<\/a><\/div>\n
Free online course: Deploy containerized applications<\/a><\/div>\n
eBook: A guide to Kubernetes for SREs and sysadmins<\/a><\/div>\n
Free online course: Running containers with Red Hat technical overview<\/a><\/div>\n
eBook: Storage patterns for Kubernetes<\/a><\/div>\n<\/p><\/div>\n<\/p><\/div>\n
Add a ZFS dataset<\/h2>\n
The following example resource directive defines a ZFS dataset. For my example, I will add it to the main.tf <\/code>file.<\/p>\n
\n
resource \"truenas_dataset\"<\/span> \"pictures\"<\/span> {<\/span>
\n\u00a0 pool = \"storage-pool\"<\/span>
\n\u00a0 name = \"pictures\"<\/span>
\n\u00a0 comments = \"Terraform created dataset for Pictures\"<\/span>
\n\u00a0}<\/span><\/div><\/div><\/pre>\n
Run the command terraform validate<\/code> to check the configuration.<\/p>\n
\nSuccess!<\/span> The configuration is valid.<\/code><\/span><\/pre>\n
Running terraform plan<\/code> will describe the actions that Terraform will perform. Now, add the new dataset with terraform apply<\/code>.<\/p>\n
\n
Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
\n\u00a0 + create

\nTerraform will perform the following actions:

\n\u00a0 # truenas_dataset.pictures will be created<\/span>
\n\u00a0 + resource \"truenas_dataset\"<\/span> \"pictures\"<\/span> {<\/span>
\n\u00a0 \u00a0 \u00a0 + acl_mode \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 = (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + acl_type \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 = (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + atime \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0= (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + case_sensitivity \u00a0 \u00a0 = (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + comments \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 = \"Terraform created dataset for Pictures\"<\/span>
\n\u00a0 \u00a0 \u00a0 + compression \u00a0 \u00a0 \u00a0 \u00a0 \u00a0= (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + copies \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 = (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + dataset_id \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 = (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + deduplication \u00a0 \u00a0 \u00a0 \u00a0= (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + encrypted \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0= (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + encryption_algorithm = (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + encryption_key \u00a0 \u00a0 \u00a0 = (<\/span>sensitive value)<\/span>
\n\u00a0 \u00a0 \u00a0 + exec<\/span> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 = (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + generate_key \u00a0 \u00a0 \u00a0 \u00a0 = (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + id<\/span> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 = (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + managed_by \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 = (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + mount_point \u00a0 \u00a0 \u00a0 \u00a0 \u00a0= (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + name \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 = \"pictures\"<\/span>
\n\u00a0 \u00a0 \u00a0 + pbkdf2iters \u00a0 \u00a0 \u00a0 \u00a0 \u00a0= (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + pool \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 = \"storage-pool\"<\/span>
\n\u00a0 \u00a0 \u00a0 + quota_bytes \u00a0 \u00a0 \u00a0 \u00a0 \u00a0= (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + quota_critical \u00a0 \u00a0 \u00a0 = (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + quota_warning \u00a0 \u00a0 \u00a0 \u00a0= (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + readonly<\/span> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 = (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + record_size \u00a0 \u00a0 \u00a0 \u00a0 \u00a0= (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + ref_quota_bytes \u00a0 \u00a0 \u00a0= (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + ref_quota_critical \u00a0 = (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + ref_quota_warning \u00a0 \u00a0= (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + share_type \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 = (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + snap_dir \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 = (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 \u00a0 + sync<\/span> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 = (<\/span>known after apply)<\/span>
\n\u00a0 \u00a0 }<\/span>

\nPlan: 1<\/span> to add, 0<\/span> to change, 0<\/span> to destroy.

\nDo you want to perform these actions?
\n\u00a0 Terraform will perform the actions described above.
\n\u00a0 Only 'yes'<\/span> will be accepted to approve.

\n\u00a0 Enter a value:<\/div><\/div><\/pre>\n
Type yes<\/code> to confirm and hit Enter<\/b>.<\/p>\n
\n
truenas_dataset.pictures: Creating...
\ntruenas_dataset.pictures: Creation complete<\/span> after 0s [<\/span>id<\/span>=storage-pool\/<\/span>pictures]<\/span>

\nApply complete<\/span>!<\/span> Resources: 1<\/span> added, 0<\/span> changed, 0<\/span> destroyed.<\/div><\/div><\/pre>\n
That’s it. You can check for this new dataset in the TrueNAS Web UI.<\/p>\n
\n
  \"The<\/div>\n
Image by: <\/span><\/p>\n
(Alan Formy-Duval, CC BY-SA 4.0)<\/p>\n<\/div>\n<\/article>\n
Do more with TrueNAS and Terraform<\/h2>\n
The TrueNAS provider for Terraform allows you to manage many more aspects of your TrueNAS device. For instance, you could share this new dataset as an NFS or server message block (SMB) share. You can also create additional datasets, cron jobs, and zvols.<\/p>\n<\/div>\n
\n
Get more out of TrueNAS when you integrate Terraform for configuration management.<\/p>\n<\/div>\n
\n
\n
  \"Puzzle<\/div>\n
Image by: <\/span><\/p>\n
Opensource.com<\/p>\n<\/div>\n<\/article>\n<\/div>\n
\n
Containers<\/a><\/div>\n
Linux<\/a><\/div>\n<\/p><\/div>\n
What to read next<\/div>\n

\n        \"Creative<\/a>This work is licensed under a Creative Commons Attribution-Share Alike 4.0 International License.<\/div>\n
\n
\n
Register<\/a> or Login<\/a> to post a comment.<\/div>\n<\/p><\/div>\n<\/section>\n
Powered by WPeMatico<\/a><\/small><\/p>\n","protected":false},"excerpt":{"rendered":"
Use Terraform to manage TrueNAS Alan Formy-Duval Mon, 06\/13\/2022 – 03:00 Register or Login to like Register or Login to like Sometimes combining different open source projects can have benefits. The synergy of using Terraform with TrueNAS is a perfect example. TrueNAS is an OpenBSD-based operating system that provides network-attached storage (NAS) and network services. […]<\/p>\n","protected":false},"author":1,"featured_media":65052,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[307],"tags":[],"class_list":["post-65051","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-open-source"],"_links":{"self":[{"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=\/wp\/v2\/posts\/65051","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=65051"}],"version-history":[{"count":0,"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=\/wp\/v2\/posts\/65051\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=\/wp\/v2\/media\/65052"}],"wp:attachment":[{"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=65051"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=65051"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=65051"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}