blob: 407a2d954c6f8cf0abb3bb38ecff85fe6e9466f0 [file] [log] [blame]
Ales Komarekef982692016-02-21 14:56:07 +01001
2==================
smolaon552ba582016-02-23 20:35:42 +01003Metal as a Service
Ales Komarekef982692016-02-21 14:56:07 +01004==================
5
6Service maas description
7
8Sample pillars
9==============
10
11Single maas service
12
13.. code-block:: yaml
14
15 maas:
16 server:
17 enabled: true
18
Ondrej Smola9af2b082016-08-25 17:37:29 +020019Single MAAS region service [single UI/API]
20
21.. code-block:: yaml
22
Damian Szelugaa8248102017-03-16 08:48:51 +010023 maas:
Damian Szeluga336ff2e2017-03-30 11:19:34 +020024 salt_master_ip: 192.168.0.10
Damian Szelugaa8248102017-03-16 08:48:51 +010025 region:
26 theme: mirantis
27 bind:
28 host: 192.168.0.10:5240
29 port: 5240
30 admin:
31 username: exampleuser
32 password: examplepassword
33 email: email@example.com
34 database:
35 engine: null
36 host: localhost
37 name: maasdb
38 password: qwqwqw
39 username: maas
40 enabled: true
41 user: mirantis
42 token: "89EgtWkX45ddjMYpuL:SqVjxFG87Dr6kVf4Wp:5WLfbUgmm9XQtJxm3V2LUUy7bpCmqmnk"
43 fabrics:
44 test-fabric:
45 description: Test fabric
46 subnets:
47 subnet1:
48 fabric: test-fabric
49 cidr: 2.2.3.0/24
50 gateway_ip: 2.2.3.2
51 iprange:
52 start: 2.2.3.20
53 end: 2.2.3.250
54 dhcp_snippets:
55 test-snippet:
56 value: option bootfile-name "tftp://192.168.0.10/snippet";
57 description: Test snippet
58 enabled: true
59 subnet: subnet1
60 boot_resources:
61 bootscript1:
62 title: bootscript
63 architecture: amd64/generic
64 filetype: tgz
65 content: /srv/salt/reclass/nodes/path_to_file
66 package_repositories:
67 Saltstack:
68 url: http://repo.saltstack.com/apt/ubuntu/14.04/amd64/2016.3/
69 distributions:
70 - trusty
71 components:
72 - main
73 - extra
74 arches: amd64
75 key: "-----BEGIN PGP PUBLIC KEY BLOCK-----
76 Version: GnuPG v2
Pavel Cizinsky5a6e2722016-08-31 15:58:13 +020077
Damian Szelugaa8248102017-03-16 08:48:51 +010078 mQENBFOpvpgBCADkP656H41i8fpplEEB8IeLhugyC2rTEwwSclb8tQNYtUiGdna9
79 m38kb0OS2DDrEdtdQb2hWCnswxaAkUunb2qq18vd3dBvlnI+C4/xu5ksZZkRj+fW
80 tArNR18V+2jkwcG26m8AxIrT+m4M6/bgnSfHTBtT5adNfVcTHqiT1JtCbQcXmwVw
81 WbqS6v/LhcsBE//SHne4uBCK/GHxZHhQ5jz5h+3vWeV4gvxS3Xu6v1IlIpLDwUts
82 kT1DumfynYnnZmWTGc6SYyIFXTPJLtnoWDb9OBdWgZxXfHEcBsKGha+bXO+m2tHA
83 gNneN9i5f8oNxo5njrL8jkCckOpNpng18BKXABEBAAG0MlNhbHRTdGFjayBQYWNr
84 YWdpbmcgVGVhbSA8cGFja2FnaW5nQHNhbHRzdGFjay5jb20+iQE4BBMBAgAiBQJT
85 qb6YAhsDBgsJCAcDAgYVCAIJCgsEFgIDAQIeAQIXgAAKCRAOCKFJ3le/vhkqB/0Q
86 WzELZf4d87WApzolLG+zpsJKtt/ueXL1W1KA7JILhXB1uyvVORt8uA9FjmE083o1
87 yE66wCya7V8hjNn2lkLXboOUd1UTErlRg1GYbIt++VPscTxHxwpjDGxDB1/fiX2o
88 nK5SEpuj4IeIPJVE/uLNAwZyfX8DArLVJ5h8lknwiHlQLGlnOu9ulEAejwAKt9CU
89 4oYTszYM4xrbtjB/fR+mPnYh2fBoQO4d/NQiejIEyd9IEEMd/03AJQBuMux62tjA
90 /NwvQ9eqNgLw9NisFNHRWtP4jhAOsshv1WW+zPzu3ozoO+lLHixUIz7fqRk38q8Q
91 9oNR31KvrkSNrFbA3D89uQENBFOpvpgBCADJ79iH10AfAfpTBEQwa6vzUI3Eltqb
92 9aZ0xbZV8V/8pnuU7rqM7Z+nJgldibFk4gFG2bHCG1C5aEH/FmcOMvTKDhJSFQUx
93 uhgxttMArXm2c22OSy1hpsnVG68G32Nag/QFEJ++3hNnbyGZpHnPiYgej3FrerQJ
94 zv456wIsxRDMvJ1NZQB3twoCqwapC6FJE2hukSdWB5yCYpWlZJXBKzlYz/gwD/Fr
95 GL578WrLhKw3UvnJmlpqQaDKwmV2s7MsoZogC6wkHE92kGPG2GmoRD3ALjmCvN1E
96 PsIsQGnwpcXsRpYVCoW7e2nW4wUf7IkFZ94yOCmUq6WreWI4NggRcFC5ABEBAAGJ
97 AR8EGAECAAkFAlOpvpgCGwwACgkQDgihSd5Xv74/NggA08kEdBkiWWwJZUZEy7cK
98 WWcgjnRuOHd4rPeT+vQbOWGu6x4bxuVf9aTiYkf7ZjVF2lPn97EXOEGFWPZeZbH4
99 vdRFH9jMtP+rrLt6+3c9j0M8SIJYwBL1+CNpEC/BuHj/Ra/cmnG5ZNhYebm76h5f
100 T9iPW9fFww36FzFka4VPlvA4oB7ebBtquFg3sdQNU/MmTVV4jPFWXxh4oRDDR+8N
101 1bcPnbB11b5ary99F/mqr7RgQ+YFF0uKRE3SKa7a+6cIuHEZ7Za+zhPaQlzAOZlx
102 fuBmScum8uQTrEF5+Um5zkwC7EXTdH1co/+/V/fpOtxIg4XO4kcugZefVm5ERfVS
103 MA==
104 =dtMN
105 -----END PGP PUBLIC KEY BLOCK-----"
106 enabled: true
107 machines:
108 machine1:
109 interfaces:
110 - one1: "11:22:33:44:55:66"
111 power_parameters:
112 power_type: ipmi
113 power_address: '192.168.10.10'
114 power_user: bmc_user
115 power_password: bmc_password
116 devices:
117 machine1-ipmi:
118 interface:
119 ip_address: 192.168.10.10
120 subnet: cidr:192.168.10.0/24
121 mac: '66:55:44:33:22:11'
Damian Szeluga336ff2e2017-03-30 11:19:34 +0200122 commissioning_scripts:
123 00-maas-06-create-raid.sh: /srv/salt/reclass/scripts/commisioning_script.sh
124 maas_config:
125 domain: mydomain.local
126 http_proxy: http://192.168.0.10:3142
127 commissioning_distro_series: xenial
128 default_distro_series: xenial
129 default_osystem: 'ubuntu'
130 default_storage_layout: lvm
131 disk_erase_with_secure_erase: true
132 dnssec_validation: 'no'
133 enable_third_party_drivers: true
134 maas_name: cfg01
135 network_discovery: 'enabled'
136 active_discovery_interval: '600'
137 ntp_external_only: true
138 ntp_servers: 10.10.11.23 10.10.11.24
139 upstream_dns: 192.168.12.13
140 enable_http_proxy: true
141 default_min_hwe_kernel: ''
142 sshprefs:
143 - 'ssh-rsa ASDFOSADFISdfasdfasjdklfjasdJFASDJfASdf923@AAAAB3NzaC1yc2EAAAADAQABAAACAQCv8ISOESGgYUOycYw1SAs/SfHTqtSCTephD/7o2+mEZO53xN98sChiFscFaPA2ZSMoZbJ6MQLKcWKMK2OaTdNSAvn4UE4T6VP0ccdumHDNRwO3f6LptvXr9NR5Wocz2KAgptk+uaA8ytM0Aj9NT0UlfjAXkKnoKyNq6yG+lx4HpwolVaFSlqRXf/iuHpCrspv/u1NW7ReMElJoXv+0zZ7Ow0ZylISdYkaqbV8QatCb17v1+xX03xLsZigfugce/8CDsibSYvJv+Hli5CCBsKgfFqLy4R5vGxiLSVzG/asdjalskjdlkasjdasd/asdajsdkjalaksdjfasd/fa/sdf/asd/fas/dfsadf blah@blah'
Ondrej Smola9af2b082016-08-25 17:37:29 +0200144
145
146Single MAAS cluster service [multiple racks]
147
148.. code-block:: yaml
149
150 maas:
151 cluster:
152 enabled: true
Jakub Pavlikf43512b2016-08-30 10:25:42 +0200153 role: master/slave
Ondrej Smola9af2b082016-08-25 17:37:29 +0200154
Ales Komarekef982692016-02-21 14:56:07 +0100155Read more
156=========
157
158*
Filip Pytlounc07d2352017-02-02 13:02:03 +0100159
160Documentation and Bugs
161======================
162
163To learn how to install and update salt-formulas, consult the documentation
164available online at:
165
166 http://salt-formulas.readthedocs.io/
167
168In the unfortunate event that bugs are discovered, they should be reported to
169the appropriate issue tracker. Use Github issue tracker for specific salt
170formula:
171
172 https://github.com/salt-formulas/salt-formula-maas/issues
173
174For feature requests, bug reports or blueprints affecting entire ecosystem,
175use Launchpad salt-formulas project:
176
177 https://launchpad.net/salt-formulas
178
179You can also join salt-formulas-users team and subscribe to mailing list:
180
181 https://launchpad.net/~salt-formulas-users
182
183Developers wishing to work on the salt-formulas projects should always base
184their work on master branch and submit pull request against specific formula.
185
186 https://github.com/salt-formulas/salt-formula-maas
187
188Any questions or feedback is always welcome so feel free to join our IRC
189channel:
190
191 #salt-formulas @ irc.freenode.net