You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add information about public ca key, access key, and secret key. (#4419)
* Add information about public ca key, access key, and secret key.
Signed-off-by: Ian Maddaus <[email protected]>
* Fix heading
Signed-off-by: Ian Maddaus <[email protected]>
* Another minor fix
Signed-off-by: Ian Maddaus <[email protected]>
* Editing
Signed-off-by: Ian Maddaus <[email protected]>
* Update 360 SaaS port number
Signed-off-by: Ian Maddaus <[email protected]>
---------
Signed-off-by: Ian Maddaus <[email protected]>
Copy file name to clipboardExpand all lines: content/360/saas/get_started/enroll_nodes.md
+69-10
Original file line number
Diff line number
Diff line change
@@ -120,9 +120,9 @@ To enroll a Windows node, follow these steps:
120
120
121
121
## Cookbook-based enrollment
122
122
123
-
With cookbook-based enrollment, you enroll nodes from the client side by uploading a [cookbook](https://docs.chef.io/cookbooks/) with enrollment settings to Chef Infra Server and then Chef Infra Client enrolls the node with Chef 360 SaaS.
123
+
With cookbook-based enrollment, you enroll nodes from the client side by uploading a [cookbook](/cookbooks/) with enrollment settings to Chef Infra Server and then Chef Infra Client enrolls the node with Chef 360 SaaS.
124
124
125
-
### Enroll nodes
125
+
### Enroll nodes with a cookbook
126
126
127
127
The `chef-cookbook-enroll` cookbook uses the `node_management_enroll` custom resource and a [wrapper cookbook](https://www.chef.io/blog/writing-wrapper-cookbooks) to define enrollment settings.
128
128
@@ -144,23 +144,82 @@ To configure the cookbooks and define enrollment settings, follow these steps:
144
144
chef generate cookbook <COOKBOOK_NAME>
145
145
```
146
146
147
-
In the [`metadata.rb` file](https://docs.chef.io/config_rb_metadata/) of your wrapper cookbook, add the following dependency to include the `chef-cookbook-enroll` cookbook:
147
+
In the [`metadata.rb` file](/config_rb_metadata/) of your wrapper cookbook, add the following dependency to include the `chef-cookbook-enroll` cookbook:
148
148
149
149
```ruby
150
150
depends 'chef360-node-enroll', '~> 1.0.0'
151
151
```
152
152
153
+
1. Copy of the Chef 360 SaaS public key and add it to your wrapper cookbook:
1. Define the `node_management_enroll` resource in your wrapper cookbook's recipe:
154
212
155
213
```ruby
156
214
node_management_enroll 'Enroll Node'do
157
215
chef_platform_url '<CHEF_360_FQDN>'
158
216
enroll_type '<ENROLLMENT_TYPE>'
159
-
api_port '<API_PORT>'
217
+
api_port '443'
160
218
access_key '<ACCESS_KEY>'
161
219
secret_key '<SECRET_KEY>'
162
220
cohort_id '<COHORT_ID>'
163
221
hab_builder_url '<HABITAT_BUILDER_URL>'
222
+
root_ca <CHEF_360_SAAS_PUBLIC_KEY>
164
223
working_dir_path '<VALID_DIR_PATH>'
165
224
upgrade_skills <UPGRADE_SKILLS>
166
225
end
@@ -170,30 +229,30 @@ To configure the cookbooks and define enrollment settings, follow these steps:
170
229
171
230
- `<CHEF_360_FQDN>` with the fully qualified domain name (FQDN) for your Chef 360 SaaS deployment.
172
231
- `<ENROLLMENT_TYPE>` with either `full` or `partial` depending on the form of enrollment. Use `full` unless you must `partial`.
173
-
- `<API_PORT>` with the API port configured in Chef 360 SaaS. The default value is `31000`.
174
-
- `<ACCESS_KEY>` with an access key for secure communication with Chef 360 SaaS. Store securely using an [encrypted Chef data bag](https://docs.chef.io/data_bags/) or a [secrets manager](https://docs.chef.io/infra_language/secrets/).
175
-
- `<SECRET_KEY>` with a secret key for secure communication with Chef 360 SaaS. Store securely using an [encrypted Chef data bag](https://docs.chef.io/data_bags/) or a [secrets manager](https://docs.chef.io/infra_language/secrets/).
232
+
- `<ACCESS_KEY>` with the access key for secure communication with Chef 360 SaaS. This should be stored using an [encrypted Chef data bag](/data_bags/) or [secrets manager](/infra_language/secrets/).
233
+
- `<SECRET_KEY>` with the secret key for secure communication with Chef 360 SaaS. This should be stored using an [encrypted Chef data bag](/data_bags/) or [secrets manager](/infra_language/secrets/).
176
234
- `<COHORT_ID>` with a valid cohort UUID. The cohort defines all skills and settings installed on the node.
177
235
- `<HABITAT_BUILDER_URL>` with the URL of the Chef Habitat Builder used by your organization. Default value: `https://bldr.habitat.sh`
236
+
- `<CHEF_360_SAAS_PUBLIC_KEY>`if TLS is enabled, with the root CA public key. For example, `node['enroll']['root_ca']`.
178
237
- `<VALID_DIR_PATH>` with a temporary working directory where all required builds are downloaded. Specify a valid path based on the OS. Default value: `/tmp`.
179
238
- `<UPGRADE_SKILLS>` with `true` or `false`. If `true`, Chef 360 SaaS checks for the latest skill versions and installs them if found. Default value: `false`.
180
239
181
240
1. Push the wrapper cookbook or policy to the Chef Infra Server.
182
241
183
-
1. If you're using a role, [upload](https://docs.chef.io/workstation/knife_cookbook/#upload) the wrapper cookbook to the Chef Infra Server:
242
+
1. If you're using a role, [upload](/workstation/knife_cookbook/#upload) the wrapper cookbook to the Chef Infra Server:
1. If you're using a Policyfile, [create `Policyfile.lock.json` file](https://docs.chef.io/workstation/ctl_chef/#chef-install) and [push](https://docs.chef.io/workstation/ctl_chef/#chef-push) the Policyfile to Chef Infra Server:
248
+
1. If you're using a Policyfile, [create `Policyfile.lock.json` file](/workstation/ctl_chef/#chef-install) and [push](/workstation/ctl_chef/#chef-push) the Policyfile to Chef Infra Server:
190
249
191
250
```bash
192
251
chef install
193
252
chef push <POLICY_GROUP><POLICYFILE>
194
253
```
195
254
196
-
1. Include the wrapper cookbook in your node's run-list by adding it to a role or Policyfile. See the [run-list](https://docs.chef.io/run_lists/) and [role](https://docs.chef.io/roles/#manage-roles) documentation for more information.
255
+
1. Include the wrapper cookbook in your node's run-list by adding it to a role or Policyfile. See the [run-list](/run_lists/) and [role](/roles/#manage-roles) documentation for more information.
197
256
198
257
The next time Chef Infra Client runs, it executes the `node_management_enroll` resource and the node is enrolled with Chef 360 SaaS.
0 commit comments