SaltStack 庫中的 Modules:
在 SaltStack 中,每個子系統插件(plug-in)都是一個 Python Module。因此,SaltStack 庫中的 Module 可以看作是一組 functions(例如:aka 命令);可以看作是一個應用(例如:mysql、docker);可以看作是一個系統組件(例如:disk、file);還可以看作是一個外部系統(gitfs)。
使用 SaltStack 庫中的 Modules 需要注意以下幾點:
(1).所有的模塊都在 salt 目錄下,每個子系統又通過不同的子目錄進行區分 ,最后每個具體的 modile 將以單獨的 .py 文件呈現出來;
(2).各個模塊以
salt
.subsystem.module 的格式命名,其中
subsystem 代表子系統,
module代表子系統模塊名。
注意:由於執行(execution)模塊是 Salt 最先有的模塊,因此其以
salt.module 的形式命名;
(3).各個模塊內包含了我們所需的 functions。
SaltStack 庫中的 Functions:
在 SaltStack 中,Functions 相當於動詞。
SaltStack 庫中 Functions 的形參(Arguments):
1.在命令行模式指定 Functions 的形參
一般而言,Functions 中必選的形參將最先被指定,同時以特定的順序排列。而非必選的形參則
都帶有默認值。
當以 Salt 命名行模式調用 Function 時,如果形參沒有以
argument=value 的形式指定,而是僅以值的形式指定,那么我們需要以空格隔開,並以特定的順序指定形參。如果以
argument=value 的形式則無所謂。
例如:定義了如下 Function
>>>
salt.modules.useradd.add(name, uid=None, gid=None, groups=None, home=None,
shell=None, unique=True, system=False, fullname='', oomnumber='',
workphone='', homephone='', createhome=True, loginclass=None)
則以命令行模式調用如下。
>>>
salt '*' user.add fred shell=/bin/zsh
注意:當使用可變形參(
可變無名參數 *args 和可變關鍵字參數 **kw )時,則可變無名形參直接以值形式填入,而可變關鍵字參數以
argument=value 的形式指定。
例如:指定了 1 個可變無名形參以及 3 個可變關鍵字形參。
>>>
salt '*' network.connect google-public-dns-a.google.com port=53 proto=udp timeout=3
2.狀態(State)系統的形參指定
State 系統的形參保存於 state file 中,基於
YAML 的語法。
例如:salt.states.user.present 定義如下。
>>>
salt.states.user.present(name, uid=None, gid=None, gid_from_name=False,
groups=None, optional_groups=None, remove_groups=True, home=None,
createhome=True, password=None, hash_password=False, enforce_password=True,
empty_password=False, shell=None, unique=True, system=False, fullname=None,
roomnumber=None, workphone=None, homephone=None, loginclass=None, date=None,
mindays=None, maxdays=None, inactdays=None, warndays=None, expire=None,
win_homedrive=None, win_profile=None, win_logonscript=None,
win_description=None)
則在 state file 中,以 YAML 語法指定類似如下。
a state example that calls user.present:
user.present:
- name: fred
- shell: /bin/zsh
參考連接:
https://docs.saltstack.com/en/getstarted/system/python.html