Skip to content

Commit ce450ed

Browse files
author
Choonho Son
authored
Merge pull request #87 from choonho/docs
Add docs/en/README.md
2 parents 20842ab + 9fc021c commit ce450ed

28 files changed

+61
-126
lines changed

docs/en/GUIDE-img/azure-account.png

73.3 KB
Loading
-335 KB
Loading
-117 KB
Loading
-169 KB
Loading
-102 KB
Loading
-357 KB
Loading
-104 KB
Loading
-129 KB
Loading
-179 KB
Loading
-48.5 KB
Loading
Loading
Loading
Loading
-388 KB
Loading
70.5 KB
Loading
-101 KB
Loading
-270 KB
Loading
40.8 KB
Loading
-262 KB
Loading
62.2 KB
Loading
-120 KB
Loading
-409 KB
Loading
-82.1 KB
Loading
-262 KB
Loading
-289 KB
Loading

docs/en/GUIDE-img/summary(h2)-1.png

-27.8 KB
Loading

docs/en/GUIDE-img/summary(h2)-2.png

-73.8 KB
Loading

docs/en/README.md

+61-126
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## Overview
22

3+
<img src="./GUIDE-img/azure-account.png" width="80%" height="80%">
4+
35
To register an Azure service account in Cloudforet, you need the four settings information below.
46

57
- **Subscription ID**
@@ -9,7 +11,8 @@ To register an Azure service account in Cloudforet, you need the four settings i
911

1012

1113
>💡 Before starting the setup guide, please make sure **Subscription ID** has been created.
12-
See the Azure Subcription Guides [Azure Documentation](https://docs.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/initial-subscriptions)
14+
15+
See the Azure Subscription Guides [Azure Documentation](https://docs.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/initial-subscriptions)
1316

1417

1518

@@ -26,13 +29,14 @@ This setup guide will take a closer look at what the above-mentioned information
2629

2730
Azure manages costs and resources in units of objects called subscriptions.
2831
The **unique identifier** that distinguishes this is **Subscription ID**.
32+
2933
See the Subscription [Azure Documentation](https://docs.microsoft.com/en-us/azure/developer/intro/azure-developer-billing#what-is-an-azure-subscription)
3034

3135
<br>
3236

3337
### Tenant ID
3438

35-
**Tenant ID** is a **unique identifier** for your organization provided by Azure Active Directory (AD).
39+
**Tenant ID** is a **unique identifier** for your organization provided by Azure Active Directory (AD) or Microsoft Extra ID.
3640
Azure AD is a cloud-based identity and access management service that you use to manage users on an organizational basis.
3741
See the Azure AD [Azure Documentation](https://docs.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-whatis)
3842

@@ -70,24 +74,22 @@ The method using **[azure_client_secret]** requires the following setting inform
7074

7175
To obtain the above information, please proceed with the settings in the following order.
7276

73-
1. [App Registration](#1-App-Registration)
74-
2. [Create resource group](#2-Resource-Group-Create)
75-
3. [Grant Role](#3-Role-Grant)
76-
4. [Authentication key generation](#4-Authentication key-generation)
77-
5. [Confirm Subscription](#5-Subscription-Confirm)
78-
6. [Service account registration](#6-Service-Account-Registration)
79-
7. [Add custom role (select)] (#7-user-specified-role-add-select)
77+
1. [App Registration](#1 App Registration)
78+
2. [Generate Authentication key](#2 Generate Authentication key)
79+
3. [Create Resource Group](#3 Create Resource Group)
80+
4. [Assign Role](#4 Assign Role)
8081

8182
<br>
8283
<br>
8384

84-
## 1-App-Registration
85+
## 1 App Registration
8586

8687
You can obtain **[Client ID]** settings information in Azure through app registration.
8788
If there is already a registered app, it can be omitted.
8889

8990
(1) Log in to [Azure Portal](https://portal.azure.com/#home).
90-
(1-1) Enter ‘app registration’ in the search box and click [App registration].
91+
92+
(1-1) Enter ‘app registrations’ in the search box and click [App registrations].
9193

9294
<img src="./GUIDE-img/create-application(h2)-1.png" width="80%" height="80%">
9395

@@ -96,8 +98,10 @@ If there is already a registered app, it can be omitted.
9698
<img src="./GUIDE-img/create-application(h2)-2.png" width="80%" height="80%">
9799

98100
(2) Enter application registration information.
99-
(2-1) Click [Only accounts in this organization directory].
101+
102+
(2-1) Click [Accounts in this organizational directory only].
100103
You can click [Selection Guide] to select an account that can access the API that suits your organization's structure.
104+
101105
(2-2) Click the [Register] button.
102106

103107
<img src="./GUIDE-img/create-application(h2)-3.png" width="80%" height="80%">
@@ -109,11 +113,42 @@ You can click [Selection Guide] to select an account that can access the API tha
109113
<br>
110114
<br>
111115

112-
## 2. Create a resource group
116+
## 2 Generate authentication key
117+
118+
Authentication keys contain **credentials** information to access Azure resources.
119+
You can obtain **[Client Secret]** setting information by creating an authentication key.
120+
121+
(1) Go to [Azure Portal](https://portal.azure.com/#home).
122+
(1-1) Enter ‘app registration’ in the search box and click [app registration] in the service list.
123+
124+
<img src="./GUIDE-img/create-key(h2)-1.png" width="80%" height="80%">
125+
126+
(2) Click the application for which you want to create an authentication key.
127+
128+
<img src="./GUIDE-img/create-key(h2)-2.png" width="80%" height="80%">
129+
130+
(3) Click the [Certificate & Secret > Client Secret] tab and then click the [New Client Secret] button.
131+
132+
<img src="./GUIDE-img/create-key(h2)-3.png" width="80%" height="80%">
133+
134+
(3-1) Enter the description information and click the [Add] button.
135+
136+
<img src="./GUIDE-img/create-key(h2)-4.png" width="80%" height="80%">
137+
138+
(3-2) Since you cannot see the generated password value again when moving the page, **note** the encryption key information.
139+
The information in the [Value] column corresponds to the **[Client Secret]** setting information.
140+
141+
<img src="./GUIDE-img/create-key(h2)-5.png" width="80%" height="80%">
142+
143+
<br>
144+
<br>
145+
146+
## 3 Create Resource Group
113147

114148
A resource group is a group for managing resources being used in Azure.
115149
You can have a 1:N relationship with your subscription.
116-
If you have created a resource group, skip this step.
150+
151+
> If you have already created a resource group, skip this step.
117152
118153
(1) Go to [Azure Portal](https://portal.azure.com/#home).
119154
(1-1) Enter ‘resource group’ in the search box and click [Resource Group] in the service list.
@@ -132,12 +167,10 @@ If you have created a resource group, skip this step.
132167
<br>
133168
<br>
134169

135-
## 3. Assign roles
170+
## 4 Assign Role
136171

137172
[Role](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions) is a collection of access permissions to Azure resources.
138173
The Azure plugin requires a role setup with appropriate permissions to collect resource information.
139-
> You can create a role with the required permissions by creating a custom role.<br>
140-
> You can check how to create a custom role in [Course 7] (#7-User-Role-Assignment-Add-Select).
141174

142175
The collector plugin does not require any permissions other than read permission.
143176
The permission information required for each plugin is as follows.
@@ -152,7 +185,9 @@ The process of granting permission in Azure for the plugin to collect resources
152185
2. Grant roles to resource groups
153186

154187
(1) This is the process of assigning roles to subscriptions.
188+
155189
(1-1) Go to [Azure Portal](https://portal.azure.com/#home).
190+
156191
(1-2) Enter ‘Subscription’ in the search box and click [Subscription] in the service list.
157192

158193
<img src="./GUIDE-img/create-role(h2)-1.png" width="80%" height="80%">
@@ -170,21 +205,24 @@ The process of granting permission in Azure for the plugin to collect resources
170205
<img src="./GUIDE-img/create-role(h2)-4.png" width="80%" height="80%">
171206

172207
(1-6) Click the [Select Member] button to select an application as a member.
208+
173209
(1-7) After adding members, click the [Select] button.
174210
Click the Review + Assign button when it becomes active.
175211

176212
<img src="./GUIDE-img/create-role(h2)-5.png" width="80%" height="80%">
177213

178-
>💡 Please select the application with the corresponding icon.
179-
> <img src="./GUIDE-img/create-role(h2)-icon.svg">
214+
>💡 Please select the application with the corresponding role.
180215
216+
<img src="./GUIDE-img/create-role(h2)-5-1.png" width="80%" height="80%">
181217
<br>
182218

183219
(2) This is the process of assigning roles to resource groups.
220+
184221
If you only want to collect resources from a specific resource group that belongs to your subscription, you must grant a role to that resource group.
185222
If you have assigned a role to your subscription, you can skip this step.
186223

187224
(2-1) Log in to [Azure Portal](https://portal.azure.com/#home).
225+
188226
(2-2) Enter ‘resource group’ in the search box and click [Resource Group] in the service list.
189227

190228
<img src="./GUIDE-img/create-role(h2)-6.png" width="80%" height="80%">
@@ -201,119 +239,16 @@ If you have assigned a role to your subscription, you can skip this step.
201239
<img src="./GUIDE-img/create-role(h2)-9.png" width="80%" height="80%">
202240

203241
(2-6) Select [User, Group, Service Principal] and then click [Select Members].
204-
(2-7) Check [Selected members] and click the [Select] button.
205-
The [Review + Assignment] button becomes activated and click it.
206242

243+
(2-7) Check [Selected members] and click the [Select] button.
207244

208-
> 💡 Selected members must have access to the selected resource group.
245+
The [Review + Assignment] button becomes activated and click it.
209246

210247
<img src="./GUIDE-img/create-role(h2)-10.png" width="80%" height="80%">
211248

212-
<br>
213-
<br>
214-
215-
## 4. Generate authentication key
216-
217-
Authentication keys contain **credentials** information to access Azure resources.
218-
You can obtain **[Client Secret]** setting information by creating an authentication key.
219-
220-
(1) Go to [Azure Portal](https://portal.azure.com/#home).
221-
(1-1) Enter ‘app registration’ in the search box and click [app registration] in the service list.
222-
223-
<img src="./GUIDE-img/create-key(h2)-1.png" width="80%" height="80%">
224-
225-
(2) Click the application for which you want to create an authentication key.
226-
227-
<img src="./GUIDE-img/create-key(h2)-2.png" width="80%" height="80%">
228-
229-
(3) Click the [Certificate & Secret > Client Secret] tab and then click the [New Client Secret] button.
230-
231-
<img src="./GUIDE-img/create-key(h2)-3.png" width="80%" height="80%">
232-
233-
(3-1) Enter the description information and click the [Add] button.
234-
235-
<img src="./GUIDE-img/create-key(h2)-4.png" width="80%" height="80%">
236-
237-
(3-2) Since you cannot see the generated password value again when moving the page, **note** the encryption key information.
238-
The information in the [Value] column corresponds to the **[Client Secret]** setting information.
239-
240-
<img src="./GUIDE-img/create-key(h2)-5.png" width="80%" height="80%">
241-
242-
<br>
243-
<br>
244-
245-
## 5. Check Subscription
246-
247-
This is the process of checking the **Subsciprtion ID**, which is the setup information required for the **[azure_client_secret]** method.
248-
Cloudforet's user guide **does not include** the process of creating an Azure subscription.
249-
For a guide to creating an Azure subscription, see [Azure Documentation](https://docs.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/initial-subscriptions).
250-
251-
(1) Go to [Azure Portal](https://portal.azure.com/#home).
252-
(1-1) Enter ‘Subscription’ in the search box and click [Subscription] in the service list.
253-
254-
<img src="./GUIDE-img/check-subscription-id(h2)-1.png" width="80%" height="80%">
255-
256-
(1-2) Check the subscription ID information, which is the value corresponding to **[Subscription ID]**.
249+
> 💡 Selected members must have access to the selected resource group.
257250
258-
<img src="./GUIDE-img/check-subscription-id(h2)-2.png" width="80%" height="80%">
259251

252+
<img src="./GUIDE-img/create-role(h2)-10-1.png" width="80%" height="80%">
260253
<br>
261254
<br>
262-
263-
## 6. Register service account
264-
265-
Now you are ready to add Cloudforet service account.
266-
You can register a service account using the setup information you obtained while going through the setup guide so far.
267-
For detailed information on how to register a service account, see **[[Cloudforet User Guide]](https://cloudforet.io/docs/guides/asset-inventory/service-account/)** Please refer to .
268-
269-
(1) Setting information required for the **[azure_client_secret]** method.
270-
Please enter the setting information below using direct input.
271-
272-
- **Subscription ID**
273-
- **Tenant ID**
274-
- **Client ID**
275-
- **Client Secret**
276-
277-
<img src="./GUIDE-img/create-service-account(h2)-1.png" width="80%" height="80%">
278-
279-
(1-1) Click the [Save] button.
280-
281-
(2) Afterwards, how to create Cloudforet’s **collector plugin** is **[[Cloudforet’s User Guide]](https://cloudforet.io/docs/guides/asset-inventory/collector/)* Please see *.
282-
283-
284-
## 7. Add custom role (optional)
285-
286-
(1) Go to subscription service.
287-
288-
(1-1) Select the [Access Control (IAM)] menu.
289-
290-
(1-2) Click the [Add] button.
291-
292-
(1-3) Click [Add custom role].
293-
294-
<img src="./GUIDE-img/create-custom-role(h2)-1.png" width="80%" height="80%">
295-
296-
(2) Enter [spaceone_custom_role] in the custom role name.
297-
298-
(2-1) Click [Start from scratch] in the standard permissions.
299-
300-
(2-2) Click the [Next] button at the bottom left.
301-
302-
<img src="./GUIDE-img/create-custom-role(h2)-2.png" width="80%" height="80%">
303-
304-
(3) Click [JSON] in the tab menu.
305-
306-
(3-1) Click the [Edit] button.
307-
308-
<img src="./GUIDE-img/create-custom-role(h2)-3.png" width="80%" height="80%">
309-
310-
(3-2) In the code block, go to [properties > permissions > actions] and [in the document](https://github.com/cloudforet-io/plugin-azure-inven-collector#custom-roles-for-collecting-azure -cloud-resources) Add the permissions listed.
311-
312-
<img src="./GUIDE-img/create-custom-role(h2)-4.png" width="80%" height="80%">
313-
314-
(3-3) Click the [Save] button.
315-
316-
(3-4) Click the [Next] button.
317-
318-
(4) After creating a custom role [3. Roles are assigned through the [Role Grant] (#3-Role-Grant) process.
319-

0 commit comments

Comments
 (0)