{"id":15167086,"url":"https://github.com/lkubb/salt-truenas-formula","last_synced_at":"2026-01-28T05:22:24.249Z","repository":{"id":213830073,"uuid":"734782825","full_name":"lkubb/salt-truenas-formula","owner":"lkubb","description":"Manage TrueNAS with Salt-SSH.","archived":false,"fork":false,"pushed_at":"2024-11-13T23:37:55.000Z","size":114,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-03T21:58:01.044Z","etag":null,"topics":["salt","salt-formula","saltstack","saltstack-formula","truenas","truenas-core"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lkubb.png","metadata":{"files":{"readme":"docs/README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-22T15:51:47.000Z","updated_at":"2024-11-13T23:37:59.000Z","dependencies_parsed_at":"2024-02-17T19:32:03.381Z","dependency_job_id":"8bfc30ae-5aad-4103-af4f-2ee1b69ef4ef","html_url":"https://github.com/lkubb/salt-truenas-formula","commit_stats":null,"previous_names":["lkubb/salt-truenas-formula"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lkubb/salt-truenas-formula","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lkubb%2Fsalt-truenas-formula","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lkubb%2Fsalt-truenas-formula/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lkubb%2Fsalt-truenas-formula/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lkubb%2Fsalt-truenas-formula/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lkubb","download_url":"https://codeload.github.com/lkubb/salt-truenas-formula/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lkubb%2Fsalt-truenas-formula/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28840088,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T02:10:51.810Z","status":"ssl_error","status_checked_at":"2026-01-28T02:10:50.806Z","response_time":57,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["salt","salt-formula","saltstack","saltstack-formula","truenas","truenas-core"],"created_at":"2024-09-27T05:24:31.613Z","updated_at":"2026-01-28T05:22:24.232Z","avatar_url":"https://github.com/lkubb.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. _readme:\n\nTrueNAS Formula\n===============\n\n|img_sr| |img_pc|\n\n.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n   :alt: Semantic Release\n   :scale: 100%\n   :target: https://github.com/semantic-release/semantic-release\n.. |img_pc| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white\n   :alt: pre-commit\n   :scale: 100%\n   :target: https://github.com/pre-commit/pre-commit\n\nManage TrueNAS with Salt.\n\nThis is a collection of states intended to be run over Salt-SSH.\n\n.. contents:: **Table of Contents**\n   :depth: 1\n\nGeneral notes\n-------------\n\nSee the full `SaltStack Formulas installation and usage instructions\n\u003chttps://docs.saltproject.io/en/latest/topics/development/conventions/formulas.html\u003e`_.\n\nIf you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section\n\u003chttps://docs.saltproject.io/en/latest/topics/development/conventions/formulas.html#writing-formulas\u003e`_.\n\nIf you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``,\nwhich contains the currently released version. This formula is versioned according to `Semantic Versioning \u003chttp://semver.org/\u003e`_.\n\nSee `Formula Versioning Section \u003chttps://docs.saltproject.io/en/latest/topics/development/conventions/formulas.html#versioning\u003e`_ for more details.\n\nIf you need (non-default) configuration, please refer to:\n\n- `how to configure the formula with map.jinja \u003cmap.jinja.rst\u003e`_\n- the ``pillar.example`` file\n- the `Special notes`_ section\n\nSpecial notes\n-------------\n* This formula is intended to be executed via ``salt-ssh``.\n* It currently relies heavily on wrapper modules that are not yet part of Salt core, but are submitted in several of my PRs.\n\nConfiguration\n-------------\nAn example pillar is provided, please see `pillar.example`. Note that you do not need to specify everything by pillar. Often, it's much easier and less resource-heavy to use the ``parameters/\u003cgrain\u003e/\u003cvalue\u003e.yaml`` files for non-sensitive settings. The underlying logic is explained in `map.jinja`.\n\n\nAvailable states\n----------------\n\nThe following states are found in this formula:\n\n.. contents::\n   :local:\n\n\n``truenas``\n^^^^^^^^^^^\nA collection of states to manage some aspects of TrueNAS.\nYou will have to target each mod explicitly, just ``truenas``\ndoes nothing.\n\n\n``truenas.certs``\n^^^^^^^^^^^^^^^^^\nManages certificates that will be imported into the certificate store.\n\nWhen using a ``ca_server``, will rely on the SSH wrapper emulation\nof ``x509.certificate_managed`` since the remote does not have access\nto the event bus.\n\nThe wrapper is found in my PR #65654 or in my formula for a private CA:\nhttps://github.com/lkubb/salt-private-ca-formula\n\n\n``truenas.minio``\n^^^^^^^^^^^^^^^^^\nManages the MinIO plugin.\n\nCurrently only manages a certificate.\n\n\n``truenas.minio.cert``\n^^^^^^^^^^^^^^^^^^^^^^\nManages a certificate for the MinIO plugin.\n\nThe jail must exist for this state to work at all.\n\n\n``truenas.sshd``\n^^^^^^^^^^^^^^^^\nManages the SSH service.\n\n\n``truenas.sshd.authorized_keys``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\nManages OpenSSH authorized keys.\nIf ``TrustedUserCAKeys`` has been specified in the server\nconfiguration (``truenas:sshd:config``), all CA keys from\n``truenas:sshd:trusted_user_ca_keys`` will be serialized\ninto the corresponding file as well.\n\n\n``truenas.sshd.config``\n^^^^^^^^^^^^^^^^^^^^^^^\nManages SSH configuration. TrueNAS automatically reloads the\nconfig, so this is mostly standalone. It still depends on\n`truenas.sshd.host_pki`_ since those should be managed before.\n\n\n``truenas.sshd.host_pki``\n^^^^^^^^^^^^^^^^^^^^^^^^^\nManages SSH host keys and other related files.\n\n\n``truenas.sshd.service``\n^^^^^^^^^^^^^^^^^^^^^^^^\nEnsures SSH service is enabled and running.\nNo config since SSH is required for any of this to work.\n\n\n``truenas.telegraf``\n^^^^^^^^^^^^^^^^^^^^\nInstalls Telegraf and manages configuration.\n\nYou need to set ``truenas:telegraf:destination``.\nIt is advised to install it on a dataset to avoid it being\nremoved during an update.\n\n\n``truenas.certs.clean``\n^^^^^^^^^^^^^^^^^^^^^^^\nDoes not remove the certificates/keys because this is hard\nto automate and can break a lot of things.\nYou will need to do this manually.\n\n\n``truenas.sshd.authorized_keys.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\nRemoves managed OpenSSH authorized keys and trusted user CA keys.\n\n\n``truenas.telegraf.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^\nRemoves Telegraf and configuration.\n\n\n\nContributing to this repo\n-------------------------\n\nCommit messages\n^^^^^^^^^^^^^^^\n\n**Commit message formatting is significant!**\n\nPlease see `How to contribute \u003chttps://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst\u003e`_ for more details.\n\npre-commit\n^^^^^^^^^^\n\n`pre-commit \u003chttps://pre-commit.com/\u003e`_ is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes.\nFirst install  the ``pre-commit`` package manager using the appropriate `method \u003chttps://pre-commit.com/#installation\u003e`_, then run ``bin/install-hooks`` and\nnow ``pre-commit`` will run automatically on each ``git commit``. ::\n\n  $ bin/install-hooks\n  pre-commit installed at .git/hooks/pre-commit\n  pre-commit installed at .git/hooks/commit-msg\n\nState documentation\n~~~~~~~~~~~~~~~~~~~\nThere is a script that semi-autodocuments available states: ``bin/slsdoc``.\n\nIf a ``.sls`` file begins with a Jinja comment, it will dump that into the docs. It can be configured differently depending on the formula. See the script source code for details currently.\n\nThis means if you feel a state should be documented, make sure to write a comment explaining it.\n\nReferences\n----------\n* https://github.com/arensb/ansible-truenas\n* https://github.com/samuelkadolph/truenas-telegraf\n* https://github.com/danb35/deploy-freenas\n* https://www.truenas.com/docs/api/core_websocket_api.htm\n* https://github.com/truenas/middleware\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flkubb%2Fsalt-truenas-formula","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flkubb%2Fsalt-truenas-formula","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flkubb%2Fsalt-truenas-formula/lists"}