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