diff --git a/content/en/docs/concepts/inventory/monitoring/_index.md b/content/en/docs/concepts/inventory/monitoring/_index.md new file mode 100644 index 00000000..a723ad7c --- /dev/null +++ b/content/en/docs/concepts/inventory/monitoring/_index.md @@ -0,0 +1,9 @@ +--- +title: "Monitoring" +linkTitle: "Monitoring" +weight: 1 +date: 2022-01-07 +description: > + About monitoring service +--- + diff --git a/content/en/docs/developers/CICD/backend-core-microservice-ci/_index.md b/content/en/docs/developers/CICD/backend-core-microservice-ci/_index.md new file mode 100644 index 00000000..c8ce7dae --- /dev/null +++ b/content/en/docs/developers/CICD/backend-core-microservice-ci/_index.md @@ -0,0 +1,33 @@ +--- +title: "Backend Core Microservice CI" +linkTitle: "Backend Core Microservice CI" +weight: 4 +date: 2022-03-14 +description: > + Detailed Explanation of Backend Core Microservice Repository CI + +--- + +## Backend Core Microservice CI process details + +
+ +![](/docs/developers/CICD/backend-core-microservice-ci/img/backend_core_microservice_ci.png) + +
+ +Backend Core microservices' 4 workflow related GitHub Action files are explained through the diagram above. Unlike the other repositories, pushes in GitHub with tags are monitored and trigger to do building the package in PyPi for testing purposes, instead of workflow tasks for master branch pushes. + +
+ +Also, Backend Core microservices are not built and uploaded on Docker. They are only managed in PyPi. + +
+ +To check the details, go to the `.github/workflow directory` in each directory. + +
+ +* api repository : [cloudforet-io/api GitHub workflow file link](https://github.com/cloudforet-io/api/tree/master/.github/workflows) +* python-core repository : [cloudforet-io/python-core GitHub workflow file link](https://github.com/cloudforet-io/python-core/tree/master/.github/workflows) + diff --git a/content/en/docs/developers/CICD/backend-core-microservice-ci/img/backend_core_microservice_ci.png b/content/en/docs/developers/CICD/backend-core-microservice-ci/img/backend_core_microservice_ci.png new file mode 100644 index 00000000..bc87d498 Binary files /dev/null and b/content/en/docs/developers/CICD/backend-core-microservice-ci/img/backend_core_microservice_ci.png differ diff --git a/content/en/docs/developers/CICD/backend-microservice-ci/_index.md b/content/en/docs/developers/CICD/backend-microservice-ci/_index.md new file mode 100644 index 00000000..eb904112 --- /dev/null +++ b/content/en/docs/developers/CICD/backend-microservice-ci/_index.md @@ -0,0 +1,28 @@ +--- +title: "Backend Microservice CI" +linkTitle: "Backend Microservice CI" +weight: 2 +date: 2022-03-14 +description: > + Detailed Explanation of Backend Microservice Repository CI + +--- + +## Backend Microservice CI process details + +
+ +![](/docs/developers/CICD/backend-microservice-ci/img/backend_microservice_ci.png) + +
+ +The flowchart above describes 4 `.yml` GitHub Action files for CI process of backend microservices. Most of the workflow is similar to the frontend microservices' CI. However, unlike the frontend microservices, backend microservices are released as packages, therefore the process includes building and uploading PyPi package. + +
+ +To check the details, go to the `.github/workflow` directory in each directory. We provide an example of the workflow directory of the backend microservices with the below link. + +
+ +* identity repository : [cloudforet-io/identity GitHub workflow file link](https://github.com/cloudforet-io/identity/tree/master/.github/workflows) + diff --git a/content/en/docs/developers/CICD/backend-microservice-ci/img/backend_microservice_ci.png b/content/en/docs/developers/CICD/backend-microservice-ci/img/backend_microservice_ci.png new file mode 100644 index 00000000..b9f7be1d Binary files /dev/null and b/content/en/docs/developers/CICD/backend-microservice-ci/img/backend_microservice_ci.png differ diff --git a/content/en/docs/developers/CICD/frontend-core-microservice-ci/_index.md b/content/en/docs/developers/CICD/frontend-core-microservice-ci/_index.md new file mode 100644 index 00000000..82b89ca0 --- /dev/null +++ b/content/en/docs/developers/CICD/frontend-core-microservice-ci/_index.md @@ -0,0 +1,36 @@ +--- +title: "Frontend Core Microservice CI" +linkTitle: "Frontend Core Microservice CI" +weight: 3 +date: 2022-03-14 +description: > + Detailed Explanation of Frontend Core Microservice Repository CI + +--- + +## Frontend Core Microservice CI + +
+ +![](/docs/developers/CICD/frontend-core-microservice-ci/img/frontend_core_microservice_ci.png) + +
+ +Frontend Core microservices' codes are integrated and built, uploaded with the flow explained above. Most of the workflows include set-up process including setting Node.js, caching node modules, and installing dependencies. After the set-up proccess, each repository workflow is headed to building process proceeded in NPM. After building, both repositories' packages built are released in NPM by code `npm run semantic-release`. + +
+ +Check semantic-release site, [npm: semantic-release](https://www.npmjs.com/package/semantic-release) for further details about the release process. + +
+ +Also, unlike other repositories deployed by the flow from Docker to Spinnaker and k8s, spaceone-design-system repository is deployed differently, based on direct deployment through AWS S3. + +
+ +To check the details, go to the `.github/workflow` directory in each directory. + +
+ +* console-core-lib repository : [cloudforet-io/console-core-lib GitHub workflow file link](https://github.com/cloudforet-io/console-core-lib/tree/master/.github/workflows) +* spaceone-design-system repository : [cloudforet-io/spaceone-design-system GitHub workflow file link](https://github.com/cloudforet-io/spaceone-design-system/tree/beta/.github/workflows) diff --git a/content/en/docs/developers/CICD/frontend-core-microservice-ci/img/frontend_core_microservice_ci.png b/content/en/docs/developers/CICD/frontend-core-microservice-ci/img/frontend_core_microservice_ci.png new file mode 100644 index 00000000..2980f67a Binary files /dev/null and b/content/en/docs/developers/CICD/frontend-core-microservice-ci/img/frontend_core_microservice_ci.png differ diff --git a/content/en/docs/developers/CICD/frontend-microservice-ci/_index.md b/content/en/docs/developers/CICD/frontend-microservice-ci/_index.md new file mode 100644 index 00000000..145f3550 --- /dev/null +++ b/content/en/docs/developers/CICD/frontend-microservice-ci/_index.md @@ -0,0 +1,28 @@ +--- +title: "Frontend Microservice CI" +linkTitle: "Frontend Microservice CI" +weight: 1 +date: 2022-03-14 +description: > + Detailed Explanation of Frontend Microservice Repository CI + +--- + +## Frontend Microservice CI process details + +
+ +![](/docs/developers/CICD/frontend-microservice-ci/img/frontend_microservice_ci.png) + +
+ +The flowchart above describes 4 `.yml` GitHub Action files for CI process of frontend microservices. Unlike the backend microservices, frontend microservices are not released as packages, so the branch tagging job does not include building and uploading the NPM software package. Frontend microservices only build software and upload it on Docker, not NPM or PyPi. + +
+ +To check the details, go to the `.github/workflow` directory in each directory. We provide an example of the workflow directory of the frontend microservices with the below link. + +
+ +* console repository : [cloudforet-io/console GitHub workflow file link](https://github.com/cloudforet-io/console/tree/master/.github/workflows) + diff --git a/content/en/docs/developers/CICD/frontend-microservice-ci/img/frontend_microservice_ci.png b/content/en/docs/developers/CICD/frontend-microservice-ci/img/frontend_microservice_ci.png new file mode 100644 index 00000000..f1360b8e Binary files /dev/null and b/content/en/docs/developers/CICD/frontend-microservice-ci/img/frontend_microservice_ci.png differ diff --git a/content/en/docs/developers/CICD/img/cicd_flow_chart.png b/content/en/docs/developers/CICD/img/cicd_flow_chart.png new file mode 100644 index 00000000..c1e6a042 Binary files /dev/null and b/content/en/docs/developers/CICD/img/cicd_flow_chart.png differ diff --git a/content/en/docs/developers/CICD/img/continuous_integration_process.png b/content/en/docs/developers/CICD/img/continuous_integration_process.png new file mode 100644 index 00000000..e640c4a2 Binary files /dev/null and b/content/en/docs/developers/CICD/img/continuous_integration_process.png differ diff --git a/content/en/docs/developers/CICD/plugin-ci/_index.md b/content/en/docs/developers/CICD/plugin-ci/_index.md new file mode 100644 index 00000000..82e90d65 --- /dev/null +++ b/content/en/docs/developers/CICD/plugin-ci/_index.md @@ -0,0 +1,68 @@ +--- +title: "Plugin CI" +linkTitle: "Plugin CI" +weight: 5 +date: 2022-03-14 +description: > + Detailed Explanation of Plugin Repository CI + +--- + +## Plugin CI process details + +
+ +Plugin repositories with name starting with ‘plugin-’ have unique CI process managed with workflow file named `push_sync_ci.yaml`. As the total architecture of CI is different from other repositories, plugin repositories' workflow files are automatically updated at every code commit. + +
+ +![](/docs/developers/CICD/plugin-ci/img/plugin_ci.png) + +
+ +We can follow the plugin CI process, step by step. + +
+ +**Step 1.** `push_sync_ci.yaml` in each plugin repository is triggered by master branch push or in a manual way. + +**Step 2.** `push_sync_ci.yaml` runs `cloudforet-io/actions/.github/worflows/deploy.yaml`. + +**Step 2-1.** `spaceone/actions/.github/worflows/deploy.yaml` runs `cloudforet-io/actions/src/main.py`. +1. `cloudforet-io/actions/src/main.py` updates each plugin repository workflow files based on the repository characteristics distinguished by topics. Newest version files of all plugin repository workflows are managed in `cloudforet-io/actions`. + +**Step 2-2.** `spaceone/actions/.github/worflows/deploy.yaml` runs `push_build_dev.yaml` in each plugin repository +1. `push_build_dev.yaml` proceeds versioning based on current date. + +2. `push_build_dev.yaml` upload the plugin image in Docker. + +3. `push_build_dev.yaml` sends notification through Slack. + +
+
+ + +To build and release the docker image of plugin repositories, plugins use `dispatch_release.yaml`. + +1. `dispatch_release.yaml` in each plugin repository is triggered manually. + +2. `dispatch_release.yaml` executes condition_check job to check version format and debug. + +3. `dispatch_release.yaml` updates master branch version file. + +4. `dispatch_release.yaml` executes git tagging. + +5. `dispatch_release.yaml` builds and pushes to Docker Hub with `docker/build-push-action@v1` + +6. `dispatch_release.yaml` sends notification through Slack. + +
+
+ + +For further details, you can check our GitHub `cloudforet-io/actions`. + +
+ +* [SpaceONE github action workflow repository](https://github.com/cloudforet-io/actions) + diff --git a/content/en/docs/developers/CICD/plugin-ci/img/plugin_ci.png b/content/en/docs/developers/CICD/plugin-ci/img/plugin_ci.png new file mode 100644 index 00000000..e99984f6 Binary files /dev/null and b/content/en/docs/developers/CICD/plugin-ci/img/plugin_ci.png differ diff --git a/content/en/docs/developers/CICD/tools-ci/_index.md b/content/en/docs/developers/CICD/tools-ci/_index.md new file mode 100644 index 00000000..b46ee547 --- /dev/null +++ b/content/en/docs/developers/CICD/tools-ci/_index.md @@ -0,0 +1,46 @@ +--- +title: "Tools CI" +linkTitle: "Tools CI" +weight: 6 +date: 2022-03-14 +description: > + Detailed Explanation of Tools Repository CI + +--- + +## Tools CI process details + +
+ +![](/docs/developers/CICD/tools-ci/img/tools_ci.png) + +
+ +spacectl, spaceone-initializer, tester repositories are tools used for the spaceone project. There are some differences from other repositories' CI process. + +
+ +spacectl repository workflow includes test code for each push with a version tag, which is similar to the CI process of backend core repositories. + +
+ +spaceone-initializer repository does not include the workflow file triggered by ‘master branch push’, which most of repositories including spacectl and tester have. + +
+ +Tools-category repositories use different repositories to upload. +* spacectl : PyPi and Docker both +* spaceone-initializer : Docker +* tester : PyPi + +
+
+ +To check the details, go to the `.github/workflow` directory in each directory. + +
+ +* spacectl repository : [cloudforet-io/spacectl GitHub workflow file link](https://github.com/cloudforet-io/spacectl/tree/master/.github/workflows) +* spaceone-initializer repository : [cloudforet-io/spaceone-initializer GitHub workflow file link](https://github.com/cloudforet-io/spaceone-initializer/tree/master/.github/workflows) +* tester repository : [cloudforet-io/tester GitHub workflow file link](https://github.com/cloudforet-io/tester/tree/master/.github/workflows) + diff --git a/content/en/docs/developers/CICD/tools-ci/img/tools_ci.png b/content/en/docs/developers/CICD/tools-ci/img/tools_ci.png new file mode 100644 index 00000000..14ef3544 Binary files /dev/null and b/content/en/docs/developers/CICD/tools-ci/img/tools_ci.png differ diff --git a/content/en/docs/guides/admin-mode/_index.md b/content/en/docs/guides/admin-mode/_index.md new file mode 100644 index 00000000..5a02c8c2 --- /dev/null +++ b/content/en/docs/guides/admin-mode/_index.md @@ -0,0 +1,24 @@ +--- +linkTitle: Admin Guide +weight: 3 +date: '2024-01-08T00:00:00.000Z' +description: > + Users with the Admin role type have top-level administrative authority within the domain. +
+ Admins can access all workspaces, including domain settings, and adjust detailed configurations. +

+ Learn more about roles [**here**](/docs/guides/admin-mode/role/). +title: Admin Guide +--- + +**Entering Admin Center** + +Click the 'Admin' toggle at the top right to switch to Admin mode. + +![](/guides/admin/admin_mode/admin-mode-01-en.png)![](/guides/admin/admin_mode/admin-mode-03-en.png) + +{{}} +※ Only users with the Admin role type can access Admin Center.
Especially, the menu structure in Admin mode differs from that in user mode. +{{
}} + +
diff --git a/content/en/docs/guides/admin-mode/app.md b/content/en/docs/guides/admin-mode/app.md new file mode 100644 index 00000000..26b05519 --- /dev/null +++ b/content/en/docs/guides/admin-mode/app.md @@ -0,0 +1,53 @@ +--- +linkTitle: App Settings +weight: 3 +date: '2024-01-08T00:00:00.000Z' +description: | + You can create and manage apps for generating Client Secrets for API/CLI access. +title: App Settings +--- + +## Accessing the Menu + +(1) Switch to Admin Center + +![](/guides/admin/admin_mode/admin-mode-01-en.png) + +(2) Navigate to \[IAM > App] + +

+ +## Creating Apps + +To use [Spacectl](https://github.com/cloudforet-io/spacectl), the CLI tool provided by Cloudforet(SpaceONE), an accessible Client Secret is required. + +In Admin Center, you can create an app with admin roles and provide its Client Secret key to other users. + +(1) Click the \[+ Create] button at the top right + +![](/guides/iam_app/app-create-00-en.png) + +(2) Enter the required information: + +1. Enter a name. +2. Select an Admin role: You can find detailed information about roles here. +3. Enter tags: input in the 'key:value' format. +4. Click the \[Confirm] button to complete the app creation. + +![](/guides/admin/iam_app/app-create-02-en.png) + +(3) Download the generated files + +![](/guides/admin/iam_app/app-create-03-en.png) + +

+ +## Regenerating Client Secret + +(1) Select the app that needs regeneration. + +(2) Click \[Actions > Regenerate Client Secret] at the top. + +* The Secret will be regenerated, and you can download the updated configuration files. + +![](/guides/admin/iam_app/app-detail-01-en.png) diff --git a/content/en/docs/guides/admin-mode/asset-inventory.md b/content/en/docs/guides/admin-mode/asset-inventory.md new file mode 100644 index 00000000..bf160365 --- /dev/null +++ b/content/en/docs/guides/admin-mode/asset-inventory.md @@ -0,0 +1,97 @@ +--- +weight: 9 +description: | + You can view and utilize the detailed features of resources across all workspaces within the domain. +title: Global Asset Management +--- + +## Accessing the Menu + +(1) Switch to Admin Center + +![](/guides/admin/admin_mode/admin-mode-01-en.png) + +

+ +## Creating Global Collectors + +{{}} +Collectors created in Admin mode are designated as Global collectors, applying across all workspaces. + +In individual workspaces, Global collectors can only collect data and cannot be modified or deleted. +{{}} + +### ➊ Creating a Collector + +(1) In Admin Center, go to \[Asset Inventory > Collector] + +(2) Click the \[+ Create] button. + +![](/guides/admin/collector/collector-01-en.png) + +(3) Select an appropriate collector for the data needed to collect + +![](/guides/admin/collector/collector-02-en.png) + +* Learn more about collector plugins [here](docs/guides/plugins/asset-inventory-collector) + +(4) Proceed through Steps 1 to 4 + +* In the final step (Step 4), you can set the collection schedule and enable 'Collect Data Immediately' upon creation. + +![](/guides/admin/collector/collector-03-en.png) + +
+ +### ➋ Editing/Deleting a Collector + +(1) In Admin Center, go to \[Asset Inventory > Collector] + +(2) Select a collector needed to modify from the list + +![](/guides/admin/collector/collector-04-en.png) + +(3) In the detailed page of the selected collector, you can edit sections such as: + +* Base Information / Schedule / Additional Options + +![](/guides/admin/collector/collector-05-en.png) + +(4) Edit the collector name or delete it: + +* Use the \[✏️] edit button next to the collector name at the top to change the name. +* Use the \[🗑️] delete button next to the collector name at the top to delete the collector. + +![](/guides/admin/collector/collector-06.png) + +
+ +### ➌ Collecting Data + +(1) In Admin Center, go to \[Asset Inventory > Collector] + +(2) With mouse over, the \[Collect Data] button appears, allowing immediate data collection + +![](/guides/admin/collector/collector-07-en.png) + +(3) Click a collector to go to the detailed page and use the \[Collect Data] button at the top for immediate collection. + +![](/guides/admin/collector/collector-08-en.png) + +{{}} +Data collection is based on (cloud) service accounts registered within each workspace. + +For managing and registering service accounts in the workspace environment, please refer to [here](/docs/guides/asset-inventory/service-account/) +{{}} + +

+ +## Viewing All Resources in the Domain + +In Admin mode, you can view all resources collected across all workspaces within the domain. + +(1) \[Asset Inventory > Cloud Service]: Overview of all cloud service resources. + +(2) \[Asset Inventory > Server]: Overview of servers within cloud service resources. + +(3) \[Asset Inventory > Security]: Security status and checklist based on the created security plugin frameworks. diff --git a/content/en/docs/guides/admin-mode/cost-explorer.md b/content/en/docs/guides/admin-mode/cost-explorer.md new file mode 100644 index 00000000..8516eb85 --- /dev/null +++ b/content/en/docs/guides/admin-mode/cost-explorer.md @@ -0,0 +1,104 @@ +--- +weight: 10 +description: > + You can view the costs of all workspaces within the domain and utilize + detailed features. +title: Global Cost Management +--- + +## Accessing the Menu + +(1) Switch to Admin Center + +![](/guides/admin/admin_mode/admin-mode-01-en.png) + +

+ +## Analyzing Costs from All Workspaces + +You can view the total costs incurred across all workspaces at once. + +(1) In Admin Center, go to \[Cost Explorer > Cost Analysis] + +(2) Click the 'Workspace' tab from the list of Group By to view costs by workspace. + +![](/guides/admin/cost/cost-analysis-01-en.png) + +(3) Set detailed analysis using the \[Filters]. + +![](/guides/admin/cost/cost-analysis-02-en.png) + +(4) Save as new cost analysis page + +* Predefined analysis pages (e.g., Monthly cost by workspace): Only **\[Save As]** is available. +* Custom cost analysis pages: You can **\[Save],** **\[Save As]**, **\[Edit/Delete]**. + +![](/guides/admin/cost/cost-analysis-03-en.png) + +{{}} +You can also check the costs incurred in each individual workspace. For details, please refer to [here](/docs/guides/cost-explorer/cost-analysis/) +{{}} + +

+ +## Setting Budgets by Workspace + +You can create and manage budgets based on workspaces relative to the total incurred costs. + +(1) In Admin mode, go to \[Cost Management > Budget] + +\[How to set a budget] + +a. Click the \[+ Create] button + +b. Set the budget according to the specific workspace and billing data source + +* Enter a name +* Select a workspace +* Select a data source +* Choose a budget plan (total budget or monthly budget) +* Click the \[Confirm] button + +![](/guides/admin/cost/cost-analysis-04-en.png) + +{{}} +You can also create and manage project-based budgets in individual workspace environments. + +For details, please refer to [here](/docs/guides/cost-explorer/budget/). +{{}} + +

+ +## Setting Cost Report + +You can configure detailed settings to view cost reports incurred across all workspaces. + +(1) In Admin mode, go to \[Cost Explorer > Cost Report]. + +(2) In the 'Next Report' widget, click the \[Settings] button to configure the report. + +* Select Language/Currency/Monthly Issue date. + +![](/guides/admin/cost/cost-analysis-05-en.png) +![](/guides/admin/cost/cost-analysis-06-en.png) + +(3) In the 'Report Recipients' widget, configure the recipients. + +![](/guides/admin/cost/cost-analysis-07-en.png) + +(4) View the overall report: + +* Cost trends for last 12 months +* Monthly total cost summary + +![](/guides/admin/cost/cost-analysis-08-en.png) + +(5) Click a specific report to view details + +![](/guides/admin/cost/cost-analysis-09-en.png) + +![](/guides/admin/cost/cost-analysis-10.png) + +{{}} +You can also view cost reports issued in individual workspace environments. For details, please refer to [here](/docs/guides/cost-explorer/cost-report/). +{{}} diff --git a/content/en/docs/guides/admin-mode/data-sources.md b/content/en/docs/guides/admin-mode/data-sources.md new file mode 100644 index 00000000..9e0dbed7 --- /dev/null +++ b/content/en/docs/guides/admin-mode/data-sources.md @@ -0,0 +1,52 @@ +--- +weight: 8 +description: | + You can view the data collection results for each data source and manage them by linking connected accounts to workspaces. +title: Data Sources +--- + +## Accessing the Menu + +(1) Switch to Admin Center + +![](/guides/admin/admin_mode/admin-mode-01-en.png) + +(2) Navigate to \[Cost Explorer > Data Sources] + +

+ +## Viewing Detailed Information of Data Sources + +{{}} +In Admin Center, you can view all data sources registered in domain. +{{}} + +(1) View the list of data sources + +![](/guides/admin/data-sources/datasources-details-01-en.png) + +(2) Select a specific data source to view detailed information + +* Basic information of the data source +* Recent data collection results + +![](/guides/admin/data-sources/datasources-details-02-en.png) + +

+ +## Managing Linked Accounts for a Data Source + +{{}} +Linked accounts from each data source are initially mapped to workspaces, and this can be changed. +{{}} + +(1) Click on a specific data source from the [Cost Explorer > Data Sources] page + +![](/guides/admin/data-sources/datasources-details-01-en.png) + +(2) On the `Linked Account` tab, reset or update the workspaces linked to each service account + +* `Reset`: Unlink the workspaces from selected accounts +* `Update`: Re-select and link a different workspace to the selected accounts + +![](/guides/admin/data-sources/datasources-edit-01-en.png) diff --git a/content/en/docs/guides/admin-mode/domain-settings.md b/content/en/docs/guides/admin-mode/domain-settings.md new file mode 100644 index 00000000..75424bf3 --- /dev/null +++ b/content/en/docs/guides/admin-mode/domain-settings.md @@ -0,0 +1,54 @@ +--- +linkTitle: Domain Settings +weight: 6 +date: '2024-01-08T00:00:00.000Z' +description: | + Provides white labeling features allowing you to customize elements such as domain name, icon, and images. +title: Domain Settings +--- + +## Accessing the Menu + +(1) Switch to Admin Center + +![](/guides/admin/admin_mode/admin-mode-01-en.png) + +(2) Navigate to \[Preferences > Domain Settings] + +

+ +## Setting Basic Information + +![](/guides/admin/domain_settings/domain-settings-01-en.png) + +Enter the domain display name and click [Save Changes] to reflect the name in the browser tab as shown below. + +![](/guides/admin/domain_settings/domain-settings-05.png) + +

+ +## Setting Brand Assets + +You can apply basic brand assets to the system, such as the main icon and login page image. + +![](/guides/admin/domain_settings/domain-settings-02-en.png) + +Enter the appropriate image URL for each asset and click [Save Changes] to apply them as shown below. + +![](/guides/admin/domain_settings/domain-settings-04-03.png) + +

+ +## Setting Timezone/Language + +You can set the default timezone and language for the domain. + +![](/guides/admin/domain_settings/domain-settings-03-en.png) + +{{}} + +Individual users can set their own timezone and language in \[My Page]. + +For existing users who already have settings configured, Individual settings will override the domain defaults. + +{{}} diff --git a/content/en/docs/guides/admin-mode/notice.md b/content/en/docs/guides/admin-mode/notice.md new file mode 100644 index 00000000..c6c408ad --- /dev/null +++ b/content/en/docs/guides/admin-mode/notice.md @@ -0,0 +1,34 @@ +--- +weight: 7 +description: | + You can use the notice feature to view system announcements and post important updates or information related to the management and operation of the domain. +title: Notices +--- + +## Accessing the Menu + +(1) Switch to Admin Center + +![](/guides/admin/admin_mode/admin-mode-01-en.png) + +(2) Navigate to \[Info > Notice] + +

+ +## Creating a New Notice + +(1) Click the \[+ Create Notice] button at the top. + +![](/guides/admin/notice/create-notice-01-en.png) + +(2) Write the notice: + +* Enter the author's name, title, and body text +* You can set the notice to be pinned at the top or displayed as a popup +* Click the \[Confirm] button to post the notice + +![](/guides/admin/notice/create-notice-02-en.png) + +{{}} +Notices written in Admin Center can also be viewed in workspaces. +{{}} diff --git a/content/en/docs/guides/admin-mode/role.md b/content/en/docs/guides/admin-mode/role.md new file mode 100644 index 00000000..fbdfa502 --- /dev/null +++ b/content/en/docs/guides/admin-mode/role.md @@ -0,0 +1,75 @@ +--- +linkTitle: Role Settings +weight: 4 +date: '2024-01-08T00:00:00.000Z' +description: | + Detailed role management is available through user role types, page access permissions, and API connections. +title: Role Settings +--- + +## Accessing the Menu + +(1) Switch to Admin Center + +![](/guides/admin/admin_mode/admin-mode-01-en.png) + +(2) Navigate to \[IAM > Role] + +

+ +## Using Managed Roles + +* Pre-provided 'Managed' roles allow you to easily identify and quickly assign roles to users: + + `Domain Admin`, `Workspace Owner`, `Workspace Member`. (Managed roles cannot be modified or deleted.) + +![](/guides/admin/iam_role/role-managed-01-en.png) + +

+ +## Creating Custom Roles + +(1) Click the \[+ Create] button at the top + +![](/guides/admin/iam_role/role-create-00-en.png) + +(2) Enter the role name + +![](/guides/admin/iam_role/role-create-01-en.png) + +(3) Select a role type + +{{}} +Learn more about permission in details [here](/docs/guides/permission/). +{{}} + +![](/guides/admin/iam_role/role-type-en.png) + +(4) Set page access permissions + +* The Admin role type has access to the entire domain, so no additional page access permissions are needed. +* Workspace Owner and Workspace Member can have page access permissions set accordingly. + +![](/guides/admin/iam_role/role-create-03-en.png) + +(5) Click the \[+ Create] button to complete the role creation + +![](/guides/admin/iam_role/role-create-05-en.png) + +

+ +## Editing/Deleting Roles + +(1) Select a role + +(2) Click \[Actions > Edit] or \[Actions > Delete] at the top + +![](/guides/admin/iam_role/role-edit-delete-01-en.png) + +(3) When 'Edit' is clicked, you will be taken to the role editing page as shown below + +![](/guides/admin/iam_role/role-edit-en.png) + +{{}} +Note: When editing a role, the role type cannot be changed. +{{}} diff --git a/content/en/docs/guides/admin-mode/service-account.md b/content/en/docs/guides/admin-mode/service-account.md new file mode 100644 index 00000000..572232bd --- /dev/null +++ b/content/en/docs/guides/admin-mode/service-account.md @@ -0,0 +1,121 @@ +--- +weight: 8 +description: > + You can add and manage top-level organization accounts for each cloud + provider, and automatically sync them to create and update workspaces and + projects in Cloudforet(SpaceONE) +title: Trusted Accounts +--- + +## Accessing the Menu + +(1) Switch to Admin Center + +![](/guides/admin/admin_mode/admin-mode-01-en.png) + +(2) Navigate to \[Asset Inventory > Service Account] + +

+ +## Managing Global Trusted Accounts + +In Admin Center, you can create and manage global `Trusted Accounts` that can be used across all workspaces. + +💡 `Trusted Account` is used for the following purposes: + +1\) Higher-level accounts + +* When creating a new `General Account`, you can attach a `Trusted Account` to avoid repeatedly entering secret and access keys, thereby simplifying the process and enhancing security in line with the organization’s structure. + +2\) Automatic Account Synchronization + +* Instead of entering individual accounts one by one, you can use the Auto Sync feature to automatically link the organizational structure configured in the cloud provider with the SpaceONE system, creating and updating workspaces and projects according to SpaceONE's structure. Detailed instructions for setting up account synchronization are provided below. + +

+ +## Setting Up Trusted Account Auto Sync + +**\[ Basic Structure ]** + +SpaceONE has a management structure of `Workspace > Project Group > Project - Service Account`. +When Cloud resources are collected, it is managed by being mapped to a Project, which can then be used for grouping purposes. + +![](/guides/admin/service_account/project-hierarchy-en.png) + +➊ Workspace + +: The top-level management structure that separates workspaces. This can be used to separate environments by company or internal organization. + +➋ Project Group + +: Represents a structure for detailed departments. It commonly has a folder structure. + +➌ Project + +: The lower management structure where actual Cloud resources are mapped. It represents a project unit and can map one or more accounts (Service Accounts) used in the project. + +* Service Account: An account used for actual data collection, which is added to the Project. + +
+ +**\[ Set Auto Synchronization ]** + +1\) Select a provider and click the \[+ Create] button + +![](/guides/admin/service_account/create-trusted-account-01-en.png) + +2\) Enter Base Information & Credentials + +3\) Turn Auto Sync ON + +![](/guides/admin/service_account/create-trusted-account-02-en.png) + +* Set the Mapping Method as needed + +![](/guides/admin/service_account/create-trusted-account-03-en.png) + +* Set Schedule: Select up to 2 times daily for sync + +![](/guides/admin/service_account/create-trusted-account-04-en.png) + +
+ +**\[ Set Auto Synchronization by Cloud Provider ]** + +* [AWS 계정 자동 동기화](/docs/guides/account-hierarchy/aws/) +* [Azure 계정 자동 동기화](/docs/guides/account-hierarchy/azure/) +* [GCP 계정 자동 동기화](/docs/guides/account-hierarchy/gcp/) + +

+ +## Viewing/Editing Trusted Accounts + +1\) Select a Trusted Account: Go to \[Asset Inventory > Service Account] in Admin Center + +![](/guides/admin/service_account/view-trusted-account-01-en.png) + +2\) Check or Edit Base Information + +![](/guides/admin/service_account/view-trusted-account-02-en.png) + +3\) Check the List of Connected General Accounts: + +💡 With auto sync turned on, + +* Accounts are automatically synced and updated according to CSP's structures. +* It allows you to sync and update accounts directly via the \[Sync Now] button. + +![](/guides/admin/service_account/view-trusted-account-03-en.png) + +4\) Check and Edit Auto Synchronization Settings: + +* Set details, turn it On or Off, change schedule, etc. + +![](/guides/admin/service_account/view-trusted-account-04-en.png) + +5\) Edit Service Account Name or Delete it: + +* Change the service account name with the \[✏️] edit button on the top right next to the title. +* Delete the service account via the \[🗑️] delete button on the top right next to the title. + +![](/guides/admin/service_account/delete-service-account.png) diff --git a/content/en/docs/guides/admin-mode/user.md b/content/en/docs/guides/admin-mode/user.md new file mode 100644 index 00000000..031929ee --- /dev/null +++ b/content/en/docs/guides/admin-mode/user.md @@ -0,0 +1,81 @@ +--- +linkTitle: User Management +weight: 2 +date: '2024-01-08T00:00:00.000Z' +description: | + You can invite new users, view and manage all users across the domain. +title: User Management +--- + +## Accessing the Menu + +(1) Switch to Admin Center + +![](/guides/admin/admin_mode/admin-mode-01-en.png) + +(2) Navigate to \[IAM > User] + +

+ +## Inviting Users + +(1) Click the \[+ Add] button at the top + +![](/guides/admin/iam_user/user-create-01-en.png) + +(2) Invite users with workspaces and roles assigned + +![](/guides/admin/iam_user/user-create-02-en.png) + +(2-1) Add user account + +* Local: Local: Enter in email format +* For other SSO such as Google, Keycloak, etc., enter according to the format configured in the domain. + +(2-2) Select if the user has the Admin role or not + +* Admin Role ON: No need to select a workspace as it grants access to the entire domain +* Admin Role OFF: Must select one or more workspaces and assign roles within those workspaces + +(2-3) Click the \[Confirm] button to complete the user invitation +
+ +{{}} +Learn more about roles [here](/docs/guides/admin-mode/role/). +{{}} + +
+ +(3) Check the added user list + +![](/guides/admin/iam_user/user-create-03-en.png) + +Clicking on a specific user allows you to see detailed user information and the list of workspaces the user belongs to. + +![](/guides/admin/iam_user/user-detail-01-en.png)![](/guides/admin/iam_user/user-detail-02-en.png) + +{{}} +Users who have not yet logged in after being invited will have their state displayed as 'Pending.' +{{}} + +

+ +## Editing Users + +(1) Click on a specific user, then click the \[Actions > Edit] button. + +![](/guides/admin/iam_user/use-edit-01-ko.png) + +(2) Edit user information: + +* Change Name +* Change Notification Email: the Admins can change the email address and verify it directly. +* Change Password: the Admins can either set a new password directly for the user or send a password reset link via email. + +![](/guides/admin/iam_user/use-edit-02-en.png) + +(3) Enable/Disable Users + +Select one or more users, then click the \[Actions > Enable] or \[Actions > Disable] button to change their active status. + +![](/guides/admin/iam_user/use-enable-disable-01-en.png) diff --git a/content/en/docs/guides/admin-mode/workspaces.md b/content/en/docs/guides/admin-mode/workspaces.md new file mode 100644 index 00000000..a5dec544 --- /dev/null +++ b/content/en/docs/guides/admin-mode/workspaces.md @@ -0,0 +1,84 @@ +--- +linkTitle: Workspace Settings +weight: 5 +date: '2024-01-08T00:00:00.000Z' +description: | + Create and manage separate workspace environments according to the size and structure of your organization. +title: Workspace Settings +--- + +## Accessing the Menu + +(1) Switch to Admin Center + +![](/guides/admin/admin_mode/admin-mode-01-en.png) + +(2) Navigate to \[Preferences > Workspaces] + +

+ +## Creating Workspaces & Inviting Users + +### Creating a Workspace + +(1) Click the \[+ Create] button at the top + +![](/guides/admin/workspaces/workspace-create-workspace-01-en.png) + +(2) Enter the basic information and create + +* Enter a name +* Enter a description +* Select the main color of the workspace +* Click the \[Confirm] button + +![](/guides/admin/workspaces/workspace-create-workspace-02-en.png) + +Once the workspace is created, you can immediately invite users. + +

+ +### Inviting Users to a New Workspace + +{{}} +Immediate invitation can be skipped; users can be added to the workspace later as well. +{{}} + +(1) Enter user accounts to add them to the list + +![](/guides/admin/workspaces/workspace-create-workspace-03-en.png) + +(2) Select a role + +![](/guides/admin/workspaces/workspace-create-workspace-04-en.png) + +(3) Click the \[Confirm] button to complete the invitation + +* You can view the user list at the bottom when you select the created workspace. + +![](/guides/admin/workspaces/workspace-create-workspace-05-en.png) + +

+ +## Editing Workspaces + +After selecting a specific workspace, click the [Actions] button at the top to make the following changes: + +* `Edit`: Edit the workspace name and description. +* `Delete`: Delete the workspace + * Upon deletion, all users associated with that workspace will lose access. +* `Enable` or `Disable`: Change the activation status of the workspace, + * When deactivated, all users associated with that workspace will lose access. + +![](/guides/admin/workspaces/workspace-enable-disable-en.png) + +

+ +## Switching to a Workspace + +* Clicking on a specific workspace name will switch to that workspace environment. +* Switching to a workspace will automatically exit the Admin Center. + +![](/guides/admin/workspaces/workspace-create-workspace-06.png) + +![](/guides/admin/workspaces/workspace-create-workspace-07-en.png) diff --git a/content/en/docs/guides/dashboards/_index.md b/content/en/docs/guides/dashboards/_index.md index 7b6f452d..c92a1365 100644 --- a/content/en/docs/guides/dashboards/_index.md +++ b/content/en/docs/guides/dashboards/_index.md @@ -1,7 +1,7 @@ --- title: "Dashboards" linkTitle: "Dashboards" -weight: 2 +weight: 4 date: 2023-10-16 description: > Dashboard service that visually represents (multi) cloud data, such as billing and assets, making complex data easy to understand at a glance. With support for various chart types and graphic elements, you can quickly grasp the essentials of your critical data. diff --git a/content/en/docs/guides/iam/_index.md b/content/en/docs/guides/iam/_index.md index de729cab..8904fe04 100644 --- a/content/en/docs/guides/iam/_index.md +++ b/content/en/docs/guides/iam/_index.md @@ -1,11 +1,9 @@ --- -title: "Administration" -linkTitle: "Administration" +title: "IAM" +linkTitle: "IAM" weight: 7 -date: 2022-06-27 +date: 2024-06-18 description: > - In the **Administration** page, you can manage and edit information, roles, policies, etc. of domain users. -
-
- You can create a [**User**](/docs/guides/administration/iam-user) and designate a [**Role**](/docs/guides/administration/iam-role) that is connected to an [**API policy**](/docs/guides/administration/iam-policy). + You can invite/manage users and configure API/CLI access through app settings within a specific workspace. + --- diff --git a/content/en/docs/guides/iam/iam-app.md b/content/en/docs/guides/iam/iam-app.md new file mode 100644 index 00000000..34137b9e --- /dev/null +++ b/content/en/docs/guides/iam/iam-app.md @@ -0,0 +1,59 @@ +--- +linkTitle: App +weight: 2 +date: '2024-01-10T00:00:00.000Z' +description: > + You can create and manage apps for issuing Client Secrets for API/CLI access + to a workspace. +title: App +--- + +## Accessing the Menu + +(1) Select a specific workspace + +![](/guides/admin/workspaces/move-to-workspace-en.png) + +(2) Go to \[IAM > App] + +{{}} +Creating apps with `Admin` privileges is only possible in 'Admin mode'. +For detailed instructions, refer to the [here](/docs/guides/admin-mode/app/). +{{}} + +

+ +## Creating an App + +To use Cloudforet(SpaceONE)'s CLI tool, [Spacectl](https://github.com/cloudforet-io/spacectl), you need an accessible Client Secret. + +You can create an app with the Workspace Owner role in a specific workspace and provide the Client Secret key of that app to other users. + +(1) Click the \[+ Create] button in the upper right corner + +![](/guides/iam_app/app-create-00-en.png) + +(2) Enter Information + +1. Enter a name +2. Select the Workspace Owner role: You can find detailed information about roles [here](/docs/guides/permission/). +3. Enter tags in the 'key:value' format +4. Click the \[Confirm] button to complete the app creation. + +![](/guides/iam_app/app-create-01-en.png) + +(3) Download the generated file + +![](/guides/iam_app/app-create-02-en.png) + +

+ +## Regenerating Client Secret + +(1) Select an app + +(2) Click \[Actions > Regenerate Client Secret] + +* A new secret will be generated, and you can download the configuration file again. + +![](/guides/iam_app/app-create-03-en.png) diff --git a/content/en/docs/guides/iam/iam-user.md b/content/en/docs/guides/iam/iam-user.md index 8df3d78f..53f44504 100644 --- a/content/en/docs/guides/iam/iam-user.md +++ b/content/en/docs/guides/iam/iam-user.md @@ -1,107 +1,84 @@ --- -title: "[IAM] User" -linkTitle: "[IAM] User" +linkTitle: User weight: 1 -date: 2022-06-23 -description: > - In the **User** page, you can create / delete Cloudforet users or enable / disable them. -
-
- You can also grant permissions to users by assigning them roles. +date: '2022-06-23T00:00:00.000Z' +description: | + You can invite and manage users for a workspace. +title: User --- +## Accessing the Menu + +(1) Select a specific workspace + +![](/guides/admin/workspaces/move-to-workspace-en.png) + +(2) Go to \[IAM > User] + + {{}} -On the [Admin > Users] page, the role that can be assigned to a user is an the `admin` type. A `user` type can be assigned to a member of a project. -For how to assign roles to project members, see [here](/docs/guides/project/project-group/#invite-project-group-members). +Inviting users with `Admin` role type is only available in 'Admin Center'. +For detailed instructions, refer to [here](/docs/guides/admin-mode/app/). {{}} -
-## Adding users -Click the [+ Add] button on the [Administration > IAM > User] page. +

-![user-create-button](/docs/guides/administration/iam-user-img/user-create-button.png) -
+## Inviting Users -There are three types of users that can be added as follows: -- **Internal user**: users who can sign in by using their ID and password on the login page -- **External user**: users added by following the external user authentication that the domain has -- **API Only**: users who are only able to use API, and for whom the Cloudforet console is not accessible -
+(1) Click the \[Invite] button at the top -### 1. Adding internal users -Internal users are users who can sign in by using their IDs and passwords on the login page. +![](/guides/iam_user/user-invite-00-en.png) -(1-1) After the [Add user] modal dialog opens, select the [Local] tab to add an internal user. +(2) Add user accounts and assign workspace roles -![user-create-modal-local](/docs/guides/administration/iam-user-img/user-create-modal-local_en.png) +![](/guides/iam_user/user-invite-01-en.png) -(1-2) After entering the ID of an internal user, click the [Check ID] button. The user ID must be in an email form, and not on the list of existing users. +(2-1) Enter & Search user accounts -(1-3) Optionally enter user name and notification email(for receiving important system-related announcements or password reset link). +You can invite both existing users within the domain and external users to the workspace. -(1-4) Either send user a password reset link or, set the password on user's behalf. (※ If you set the password manually, you will need to directly inform the user of the password) +* Local: Enter the email format. +* If SSO such as Google, Keycloak, etc., is added to the domain, enter according to the corresponding format. -(1-5) To assign admin role to the user, you can activate the 'Admin Role' section at the bottom of the modal window and grant a specific role. +(2-2) Select a workspace access role -![user-create-local-admin-role](/docs/guides/administration/iam-user-img/user-create-local-admin-role_en.png) +(2-3) Click the \[Confirm] button to complete the user invitation {{}} -Page access permissions or API policies are differently applied depending on the role assigned to the user . For detailed information on roles, see [here](/docs/guides/administration/iam-role). +For detailed information on roles, please refer to [here](/docs/guides/admin-mode/role/). {{}} -(1-6) Click the [Confirm] button to complete the user addition.
-### 2. Adding external users -Adding an external user follows the external user authentication that the domain has. Without authentication as an external user, one cannot be added as a user. +(3) Check the invited user list -(2-1) After opening the [Add User] modal, select a specific SSO tab for adding external users. ex. Google OAuth +![](/guides/iam_user/user-invite-02-en.png) -![user-create-modal-oauth](/docs/guides/administration/iam-user-img/user-create-modal-oauth_en.png) - -(2-2) Enter an existing authenticated external user account. +By clicking on a specific user, you can view detailed user information as well as the list of `projects` the user belongs to. {{}} -For a detailed description on external user authentication, see [here](/docs/guides/plugins/iam-authentication/). +If the invited user has not logged in yet, their state will be displayed as 'Pending'. {{}} -(2-3) Optionally enter user name and notification email(for receiving important system-related announcements or password reset link). - -(2-4) To assign admin role to the user, you can activate the 'Admin Role' section at the bottom of the modal window and grant a specific role. +

-(2-5) Click the [Confirm] button to complete the user addition. -
- - -### 3. Adding API only users -API users cannot access the Cloudforet console and can only use the API. +## Editing Users -(3-1) After the [Add user] modal dialog opens, select the [API Only] tab. +Workspace Owners can only modify or remove user roles, and cannot edit other user information. -![user-create-modal-apionly](/docs/guides/administration/iam-user-img/user-create-modal-apionly_en.png) +(1) Change roles -(3-2) After entering the ID, click the [Check ID] button. The user ID must not be on the list of existing users. +* Click the dropdown button in the user's Role display to change the role. -(3-3) Optionally enter user name. +![](/guides/iam_user/user-edit-01-en.png) -(3-4) To assign admin role to the user, you can activate the 'Admin Role' section at the bottom of the modal window and grant a specific role. - -(3-5) Click the [Confirm] button to complete the user addition. -
-
+(2) Remove users from the workspace -## Viewing user details -By selecting a specific user from the table on the user page, you can view detailed information on that user. +* Click the \[Remove] button to remove the user. -![user-single-select](/docs/guides/administration/iam-user-img/user-single-select.png) -
-
+{{}} -## Updating users -By selecting a specific user in the table and clicking on [Actions > Edit], you can modify the user's information. +When a user is removed, they are removed from the workspace but remain in the domain as a user. -![user-update-modal](/docs/guides/administration/iam-user-img/user-update-modal_en.png) -- You can modify the user's ID, name, notification email, password, admin role (role), and tags. -- If the user encounters difficulties with verification for the notification email, you can directly verify it without sending verification code. -- For local users, you can either change the password on their behalf or send them a password reset link for the user to reset it themselves. \ No newline at end of file +{{}} diff --git a/content/en/docs/guides/permission.md b/content/en/docs/guides/permission.md new file mode 100644 index 00000000..2c919096 --- /dev/null +++ b/content/en/docs/guides/permission.md @@ -0,0 +1,100 @@ +--- +linkTitle: User permission +weight: 2 +date: '2024-01-08T00:00:00.000Z' +description: > + It provides a basic role-based permission system, enabling you to assign + user-specific access rights and manage the system effectively, tailored to + your organization’s structure and objectives. +title: User permission +--- + +## Role Type + +Roles are defined based on three types: + +* `Admin`: has access to all workspaces, including domain settings and Admin mode. +* `Workspace Owner`: has access to all projects within the workspace. +* `Workspace Member`: has access only to projects they are invited to or that are public within the workspace. + +![](/guides/admin/iam_role/role-type-en.png) + +You can find detailed information about the permissions for each role type below. + +

+ +## Admin Role Type + +
+ +**✓ Domain-Wide Management** + +* Manage all users including admins within the domain +* Invite and manage users across all workspaces +* Assign roles: Admin, Workspace Owner, Workspace Member +* Restrict access to specific service menus based on roles + +**✓ All Workspace Management** + +* Create/Delete/Enable/Disable workspaces +* Access settings for all workspaces + +**✓ App (Client Secret) Management** + +* Create and mange domain-level access apps (Client Secrets) +* Assign apps (Client Secrets) to Admin roles + +**✓ Domain Settings** + +* Configure domain display, icons, and other white labeling settings +* Set the domain timezone and language + +**✓ Service Management** + +* Create data collectors or budget allocations at a global level + +

+ +## Workspace Owner Role Type + +**✓ Specific Workspace User Management** + +* Invite and manage users within the workspace +* Assign roles: Workspace Owner, Workspace Member + +**✓ Workspace App (Client Secret) Management** + +* Create and manage workspace-level access apps (Client Secrets) +* Assign apps (Client Secrets) to Workspace Owner roles + +**✓ Project Management** +* Create new projects and project groups, and invite users to them + +**✓ Service Management** + +* Manage each service within a workspace + +

+ +## Workspace Member Role Type + +✓ View data within the invited workspace, with limited management capabilities + +✓ Access only to projects they are invited to or that are public within the workspace + + +

+ +## Workspace Owner vs Workspace Member + +{{}} +Workspace Owners and Workspace Members have access only to the workspaces they belong to. +{{}} + +![](/guides/admin/iam_role/role-type-comparison-en.png) + +

+ +{{}} +Learn more about creating and managing roles [here](/docs/guides/admin-mode/role/). +{{}} diff --git a/content/ko/docs/guides/account-hierarchy/Kubernetes--.md b/content/ko/docs/guides/account-hierarchy/Kubernetes--.md new file mode 100644 index 00000000..e3aa11e7 --- /dev/null +++ b/content/ko/docs/guides/account-hierarchy/Kubernetes--.md @@ -0,0 +1,94 @@ +--- +weight: 3 +description: | + Kubernetes Cluster 계정 연동 가이드 +title: Kubernetes 계정 연동 +--- + +## 쿠버네티스 서비스 어카운트 생성하기 + +(1) \[에셋 인벤토리 > 서비스 계정] 페이지에서 쿠버네티스 서비스를 선택합니다. + +![](/guides/account-hierarchy/create-general-account-01-ko.png) + +(2) \[+생성] 버튼을 클릭합니다. + +![](/guides/account-hierarchy/create-general-account-02-ko.png) + +(3) 서비스 계정 생성 폼을 작성합니다. + +(3-1) SpaceONE에 생성하고자 하는 서비스 어카운트 이름을 입력합니다. + +![](/guides/account-hierarchy/create-general-account-03-ko.png) + +(3-2) 해당 서비스 계정에 연결할 프로젝트를 지정합니다. + +![](/guides/account-hierarchy/create-general-account-04-ko.png) + +(4) \[추가] 버튼을 클릭하여 완료합니다. + +
+ +## 쿠버네티스 클러스터 연결하기 + +(1) 연결하고자 하는 서비스 어카운트 페이지에서 \[+클러스터 연결하기] 버튼을 클릭합니다. + +![](/guides/account-hierarchy/connect-cluster-01-ko.png) + +(2) 클러스터 기본 정보를 작성합니다. + +(2-1) 시스템에 설치되어 있는 클러스터 이름을 입력합니다. + +![](/guides/account-hierarchy/connect-cluster-02-ko.png) + +(2-2) `kube-state-metrics`, `prometheus-node-exporter` 두 가지 항목이 클러스터에 설치되었는지 확인이 필요합니다. + +만약, 하나의 항목이라도 설치되어 있지 않다면 SpaceONE 에이전트에서 대신 설치됩니다. + +![](/guides/account-hierarchy/connect-cluster-03-ko.png) + +(3) 로컬 helm 저장소에 SpaceONE 에이전트 추가합니다. + +{{}} +클러스터 연결을 위해서 시스템에 SpaceONE Helm 저장소가 설치되어 있어야 합니다. +{{}} + +![](/guides/account-hierarchy/connect-cluster-04-ko.png) + +(4) 클라우드 셀이나 터미널에 코드를 복사하여 SpaceONE 에이전트를 클러스터에 설치합니다. + +![](/guides/account-hierarchy/connect-cluster-05-ko.png) + +(5) \[완료] 버튼을 클릭하여 클러스터 연결을 완료합니다. + +
+ +## 쿠버네티스 클러스터 연결하기 + +삭제하고자 하는 서비스 어카운트 페이지에 진입합니다. + +삭제 아이콘 버튼을 통해 해당 서비스 어카운트를 삭제할 수 있습니다. + +![](/guides/account-hierarchy/delete-service-account-01-ko.png) + +서비스 어카운트 삭제시 해당 어카운트로 수집된 모든 데이터가 유실됩니다. + +![](/guides/account-hierarchy/delete-service-account-02-ko.png) + +
+ +## 연결된 쿠버네티스 클러스터 편집하기 + +편집하고자 하는 서비스 어카운트 페이지에 진입합니다. + +### 연결된 쿠버네티스 클러스터 비활성화하기 + +\[비활성화] 버튼을 눌러 클러스터 연결을 일시적으로 해제할 수 있습니다. + +### 연결된 쿠버네티스 클러스터 재연결하기 + +\[재연결] 버튼을 눌러 클러스터를 다시 연결할 수 있습니다. + +### 연결된 쿠버네티스 클러스터 삭제하기 + +\[삭제] 버튼을 클릭하여 연결된 클러스터 정보를 삭제할 수 있습니다. diff --git a/static/guides/admin/iam_role/role-edit-delete-01-en.png b/static/guides/admin/iam_role/role-edit-delete-01-en.png new file mode 100644 index 00000000..27a23450 Binary files /dev/null and b/static/guides/admin/iam_role/role-edit-delete-01-en.png differ diff --git a/static/guides/admin/iam_role/role-type-comparison-en.png b/static/guides/admin/iam_role/role-type-comparison-en.png new file mode 100644 index 00000000..194c6918 Binary files /dev/null and b/static/guides/admin/iam_role/role-type-comparison-en.png differ