Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update English Guides #24

Merged
merged 1 commit into from
Jun 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions content/en/docs/concepts/inventory/monitoring/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "Monitoring"
linkTitle: "Monitoring"
weight: 1
date: 2022-01-07
description: >
About monitoring service
---

Original file line number Diff line number Diff line change
@@ -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

</br>

![](/docs/developers/CICD/backend-core-microservice-ci/img/backend_core_microservice_ci.png)

</br>

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.

</br>

Also, Backend Core microservices are not built and uploaded on Docker. They are only managed in PyPi.

</br>

To check the details, go to the `.github/workflow directory` in each directory.

</br>

* 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)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions content/en/docs/developers/CICD/backend-microservice-ci/_index.md
Original file line number Diff line number Diff line change
@@ -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

</br>

![](/docs/developers/CICD/backend-microservice-ci/img/backend_microservice_ci.png)

</br>

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.

</br>

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.

</br>

* identity repository : [cloudforet-io/identity GitHub workflow file link](https://github.com/cloudforet-io/identity/tree/master/.github/workflows)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -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

</br>

![](/docs/developers/CICD/frontend-core-microservice-ci/img/frontend_core_microservice_ci.png)

</br>

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`.

</br>

Check semantic-release site, [npm: semantic-release](https://www.npmjs.com/package/semantic-release) for further details about the release process.

</br>

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.

</br>

To check the details, go to the `.github/workflow` directory in each directory.

</br>

* 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)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions content/en/docs/developers/CICD/frontend-microservice-ci/_index.md
Original file line number Diff line number Diff line change
@@ -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

</br>

![](/docs/developers/CICD/frontend-microservice-ci/img/frontend_microservice_ci.png)

</br>

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.

</br>

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.

</br>

* console repository : [cloudforet-io/console GitHub workflow file link](https://github.com/cloudforet-io/console/tree/master/.github/workflows)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
68 changes: 68 additions & 0 deletions content/en/docs/developers/CICD/plugin-ci/_index.md
Original file line number Diff line number Diff line change
@@ -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

</br>

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.

</br>

![](/docs/developers/CICD/plugin-ci/img/plugin_ci.png)

</br>

We can follow the plugin CI process, step by step.

</br>

**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.

</br>
</br>


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.

</br>
</br>


For further details, you can check our GitHub `cloudforet-io/actions`.

</br>

* [SpaceONE github action workflow repository](https://github.com/cloudforet-io/actions)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 46 additions & 0 deletions content/en/docs/developers/CICD/tools-ci/_index.md
Original file line number Diff line number Diff line change
@@ -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

</br>

![](/docs/developers/CICD/tools-ci/img/tools_ci.png)

</br>

spacectl, spaceone-initializer, tester repositories are tools used for the spaceone project. There are some differences from other repositories' CI process.

</br>

spacectl repository workflow includes test code for each push with a version tag, which is similar to the CI process of backend core repositories.

</br>

spaceone-initializer repository does not include the workflow file triggered by ‘master branch push’, which most of repositories including spacectl and tester have.

</br>

Tools-category repositories use different repositories to upload.
* spacectl : PyPi and Docker both
* spaceone-initializer : Docker
* tester : PyPi

</br>
</br>

To check the details, go to the `.github/workflow` directory in each directory.

</br>

* 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)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions content/en/docs/guides/admin-mode/_index.md
Original file line number Diff line number Diff line change
@@ -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.
<br>
Admins can access all workspaces, including domain settings, and adjust detailed configurations.
<br><br>
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)

{{<alert>}}
※ Only users with the Admin role type can access Admin Center. <br> Especially, the menu structure in Admin mode differs from that in user mode.
{{</alert>}}

<br>
53 changes: 53 additions & 0 deletions content/en/docs/guides/admin-mode/app.md
Original file line number Diff line number Diff line change
@@ -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]

<br> <br>

## 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)

<br> <br>

## 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)
Loading
Loading