Skip to content

docs(ko): proofread installation #823

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.

Sign up for GitHub

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

Open
jk-kim0 wants to merge 1 commit into
base: main
Choose a base branch
from
+87 −111
Open

docs(ko): proofread installation #823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 2 additions & 3 deletions src/content/ko/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,14 @@ confluenceUrl: 'https://querypie.atlassian.net/wiki/spaces/QM/pages/544375808'
QueryPie ACP는 모든 버전에 대해 사전 빌드된 Docker 이미지를 제공하며, Public Cloud의 Linux VM 또는 On-Premise 환경의 리눅스 서버 환경에서 쉽고 빠르게 설치할 수 있습니다.
설치를 위한 인스턴스의 사양으로 4 vCPU, 16 GiB Memory, 100 GiB 이상의 Disk 공간을 권장합니다.

상세한 설치 안내는 다음의 문서를 참조하세요:
상세한 설치 안내는 다음 문서를 참조하세요:

* [설치 전 준비사항](installation/prerequisites)
* [설치하기](installation/installation)
* [시스템 아키텍처와 네트워크 접근제어](installation/system-architecture-and-network-access-control)
* [컨테이너 환경변수](installation/container-environment-variables)
* [라이선스 설치](installation/license-installation)
* [서버구성 요구사항](installation/server-configuration-requirements)
* [서버 구성 요구사항](installation/server-configuration-requirements)
* [QueryPie ACP Community Edition](installation/querypie-acp-community-edition)
* [MCP 설정 가이드](installation/querypie-acp-community-edition/mcp-configuration-guide)


6 changes: 2 additions & 4 deletions src/content/ko/installation/container-environment-variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,9 +176,9 @@ A: 변경하는 절차가 복잡하고 고객사 이용자에게 불편을 주

* compose-env 파일에서 해당값을 변경하고, QueryPie Container 를 재시작해 주어야 합니다.
* 이중화, 다중화 구성의 경우, 모든 QueryPie Container 가 동일한 값을 가져야 합니다.
* ⚠️ User Agent 사용자들은 설치한 User Agent 를 삭제, Uninstall 한 이후, 재설치하여 사용하여야 합니다.
* ⚠️ User Agent 사용자는 설치한 User Agent를 삭제(Uninstall)한 이후 재설치해 사용해야 합니다.

초기에 어떤 값으로 생성해야할지 애매하다면 그냥 리눅스 터미널에서 `uuidgen | tr -d '-'` 으로 생성된 값을 사용하여도 됩니다.
초기에 어떤 값으로 생성해야 할지 애매하다면 리눅스 터미널에서 `uuidgen | tr -d '-'` 으로 생성된 값을 사용해도 됩니다.

해당 환경변수는 이용자가 입력하지 않고, 서버 내에서 스스로 구성하는 방식으로 대체될 계획이 있습니다.

Expand Down Expand Up @@ -239,5 +239,3 @@ Redis 와 QueryPie Container 를 재시작하게 되면, QueryPie Container 가
### 고급기능을 위한 환경변수

[Environment Variables for Advanced Setup - 10.3.x (KO)](https://querypie.atlassian.net/wiki/spaces/QCP/pages/954597480) 페이지를 참조하세요.


3 changes: 1 addition & 2 deletions ...installation/container-environment-variables/optimizing-dbmaxconnectionsize.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Server Container 의 수가 늘어나면, `DB_MAX_CONNECTION_SIZE` 를 낮춥니
### `DB_MAX_CONNECTION_SIZE`와 하드웨어 용량의 관계식

개발팀 내부의 성능 최적화 테스트를 통해, `DB_MAX_CONNECTION_SIZE` 과 QueryPie Server VM, DB 의 하드웨어 처리용량 사이에 다음의 관계식이 있다는 것을 도출하였습니다.
이 관계식을 참조하여, `DB_MAX_CONNECTION_SIZE` 값을 설정하면, 최적의 처리성능을 얻는 동시에, 가능한 작은 `DB_MAX_CONNECTION_SIZE` 값을 설정할 수 있습니다.
이 관계식을 참조해 `DB_MAX_CONNECTION_SIZE` 값을 설정하면 최적의 처리 성능을 얻는 동시에 가능한 작은 `DB_MAX_CONNECTION_SIZE` 값을 설정할 수 있습니다.

#### QueryPie MySQL 을 분리구성하는 경우

Expand Down Expand Up @@ -152,4 +152,3 @@ QueryPie 이용자 수가 적고, 이용량 부하가 낮은 경우, `DB_MAX_CON
`DB_MAX_CONNECTION_SIZE` 를 기본값 20이 아닌, 10 또는 5 로 낮추어 설정합니다.
PoC 환경의 경우, `DB_MAX_CONNECTION_SIZE` 를 5 로 설정하여도, 일반적인 기능 테스트를 원활히 수행할 수 있습니다.


11 changes: 5 additions & 6 deletions src/content/ko/installation/container-environment-variables/querypieweburl.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ QUERYPIE_WEB_URL은 서비스 접근, 인증 연동, 데이터 다운로드, 외

* SAML/Google BigQuery OAuth 등 인증 연동을 위한 Redirect URL
* SCIM 연동을 위한 엔드포인트 URL
* 다른 서버에 설치하는 컴포넌트 NOVAc 등에서 QueryPie Container 로 연결하는 URL
* Alert, 이메일, Slack DM 등에서 QueryPie 로 이동하는 링크의 URL
* User Agent 설치를 위해 파일을 내려 받는 링크의 URL
* Server Agent 설치를 위해 파일을 내려 받는 링크의 URL
* 다른 서버에 설치하는 컴포넌트 NOVAc 등에서 QueryPie Container로 연결하는 URL
* Alert, 이메일, Slack DM 등에서 QueryPie로 이동하는 링크의 URL
* User Agent 설치를 위해 파일을 내려받는 링크의 URL
* Server Agent 설치를 위해 파일을 내려받는 링크의 URL
* Audit Export Log/Report 감사 로그 및 보고서 파일을 내려받는 링크의 URL
* AiDD 스캔 결과를 내려받는 링크의 URL (AIDD는 11.1.0 이후 제거된 기능)
* 세션 레코딩 파일을 내려받는 링크의 URL
Expand All @@ -35,7 +35,7 @@ QUERYPIE_WEB_URL은 서비스 접근, 인증 연동, 데이터 다운로드, 외

**Q. 내부망에서만 사용하는 경우에도 도메인 설정이 필요한가요?** <br/> **A.** IP를 사용해도 무방합니다.
다만, 사용자 PC에서 접근할 수 있는 주소(IP 또는 도메인)여야 합니다.
사용자 PC 에서 접근할 수 없는 Private IP Address 를 사용하지 않아야 합니다.
사용자 PC에서 접근할 수 없는 Private IP Address를 사용하지 않아야 합니다.


**Q. IdP로 Okta를 사용하는 경우에 도메인 설정이 필요한가요?** <br/> **A.** 네, 필요합니다.
Expand All @@ -49,4 +49,3 @@ Okta에서는 Base URL 입력 시 반드시 https:// 프로토콜을 포함한 U

따라서, 도메인을 포함한 HTTPS URL을 사용하여 설정해 주세요.


31 changes: 15 additions & 16 deletions src/content/ko/installation/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,44 +5,43 @@ confluenceUrl: 'https://querypie.atlassian.net/wiki/spaces/QM/pages/1689387010'

# 설치하기

QueryPie ACP 제품을 설치하는 방법은 Container 실행방식, 설치 도우미 프로그램의 버전에 따라, 안내 문서가 구분되어 제공됩니다.
QueryPie ACP 제품을 설치하는 방법은 Container 실행 방식, 설치 도우미 프로그램 버전에 따라 안내 문서가 구분되어 제공됩니다.

### Compose Tool 로 Container 를 실행하기
### Compose Tool로 Container를 실행하기

일반적인 설치, 실행 방법이며, 제조사에서 권장하는 설치 방법입니다.
Docker Compose 를 활용하여, Container Image 를 내려받고, 실행, 종료하는 방식입니다.
일반적인 설치/실행 방법이며 제조사에서 권장하는 방식입니다.
Docker Compose를 활용하여 Container Image를 내려받고 실행/종료합니다.

이 경우, 설치 도우미 프로그램의 버전에 따라, 두 가지 설치 방식이 제공됩니다.

#### setup.v2.sh 로 설치하기
#### setup.v2.sh로 설치하기

2025년 8월 출시된 QueryPie ACP Community Edition 의 출시와 함께 최종 고객사와 파트너 엔지니어에게 제공되는 설치 도우미 프로그램입니다.
Docker Hub 에 공개된 Container Image 를 내려받아 설치하는 방식입니다.
2025년 8월 출시된 QueryPie ACP Community Edition과 함께 최종 고객사와 파트너 엔지니어에게 제공되는 설치 도우미 프로그램입니다.
Docker Hub에 공개된 Container Image를 내려받아 설치하는 방식입니다.

설치 과정이 자동화되어, 처음 설치하는 이용자가 제품을 쉽게 설치할 수 있습니다.
setup.v2.sh 가 실제로 실행하는 설치 과정은 setup.sh 의 설치 방식과 동등합니다.
setup.v2.sh 는 그 과정이 자동화되었고, Version 10 등 구버전의 설치를 지원하지 않는다는 차이가 있습니다.
설치 과정이 자동화되어 처음 설치하는 이용자도 제품을 쉽게 설치할 수 있습니다.
setup.v2.sh가 실제로 실행하는 설치 과정은 setup.sh의 설치 방식과 동등합니다.
setup.v2.sh는 그 과정이 자동화되었고 Version 10 등 구버전 설치를 지원하지 않는다는 차이가 있습니다.
더 상세한 차이점은 이 문서를 참조하세요: [setup.sh, setup.v2.sh 비교](installation/comparison-of-setupsh-and-setupv2sh)

Apple Silicon 을 사용하는 macOS 환경의 설치를 지원합니다.

자세한 설치 방법은 이 문서를 참조하세요: [설치 가이드 - setup.v2.sh](installation/installation-guide-setupv2sh)

#### setup.sh 로 설치하기
#### setup.sh로 설치하기

QueryPie ACP Version 9 시절부터 파트너 엔지니어에게 제공된 설치 도우미 프로그램입니다.
Harbor 라는 Container Registry 에 계정을 발급받아 Container Image 를 내려받을 수 있습니다.
Harbor라는 Container Registry에서 계정을 발급받아 Container Image를 내려받을 수 있습니다.

자세한 설치 방법은 이 문서를 참조하세요: [설치 가이드 - 간단한 구성](installation/installation-guide-simple-configuration)

### Kubernetes 환경에 설치하기

QueryPie ACP 는 Container 환경에서 작동하는 소프트웨어 제품입니다.
Compose Tool 을 이용해 설치, 실행하는 것이 일반적이지만, Kubernetes 환경에서도 매끄럽게 작동합니다.
QueryPie ACP는 Container 환경에서 작동하는 소프트웨어 제품입니다.
Compose Tool을 이용해 설치/실행하는 것이 일반적이지만 Kubernetes 환경에서도 매끄럽게 작동합니다.

Kubernetes 환경에서 제품을 설치하는 경우, AWS EKS, GCP GKE 등 Managed Kubernetes Cluster 와 Self-Hosted Cluster, 모두 사용 가능합니다.
Kubernetes 환경에서 제품을 설치하는 경우 AWS EKS, GCP GKE 등 Managed Kubernetes Cluster와 Self-Hosted Cluster를 모두 사용할 수 있습니다.

* AWS EKS 환경 : [AWS EKS 환경에서 설치하기](installation/installing-on-aws-eks)
* Helm Chart : [https://github.com/chequer-io/querypie-deployment](https://github.com/chequer-io/querypie-deployment)


8 changes: 3 additions & 5 deletions src/content/ko/installation/installation/comparison-of-setupsh-and-setupv2sh.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ MySQL Data Dir 의 경로가 변경되면서, 다음의 장점이 생깁니다.

두 가지 유의사항이 있습니다.

* setup.sh 는 기존 QueryPie MySQL Container 를 최초 설치 버전의 경로에서 작동하는 MySQL Container 를 유지하여야 합니다. setup.v2.sh 는 **현재 설치 버전의 경로에서 MySQL Container 를 실행** 합니다.
* setup.sh 로 제품을 이미 설치한 서버에, setup.v2.sh 를 이용해 새로운 버전을 설치할 수 있습니다. 그러나, MySQL Data Dir 변경에 따라, **기존 데이터가 자동으로 이관되지 않습니다** . 새로운 설치, 업그레이드 등 목적에 따라, MySQL Data 디렉토리를 설치 담당자가 적절히 이동하여야 합니다.
* setup.sh 는 기존 QueryPie MySQL Container 를 최초 설치 버전의 경로에서 작동하는 MySQL Container 로 유지해야 합니다. setup.v2.sh 는 **현재 설치 버전의 경로에서 MySQL Container 를 실행** 합니다.
* setup.sh 로 제품을 이미 설치한 서버에 setup.v2.sh 를 이용해 새로운 버전을 설치할 수 있습니다. 그러나 MySQL Data Dir 변경에 따라 **기존 데이터가 자동으로 이관되지 않습니다** . 새로운 설치, 업그레이드 등 목적에 따라 설치 담당자가 MySQL Data 디렉토리를 적절히 이동해야 합니다.


### Rootless Mode 지원
Expand All @@ -77,7 +77,7 @@ setup.v2.sh 로 설치하는 경우, Rootless Mode 의 Docker, Podman 환경에

Rootless Mode 로 Container Engine 을 실행하도록 먼저 환경을 구성합니다.
setup.v2.sh 를 이용하여 Podman 을 설치하는 경우, 기본적으로 Rootless Mode 환경이 적용됩니다.
Docker 를 사용하는 경우, 별도의 문서를 참조하여, Rootless Mode 설정을 수행하여야 합니다.
Docker 를 사용하는 경우 별도 문서를 참조해 Rootless Mode 설정을 수행해야 합니다.

이후, `setup.v2.sh` 를 실행할 때, `--universal` 옵션을 추가하여, QueryPie 를 설치하면, Rootless Mode 에 적합한 Compose package.tar.gz 이 설치됩니다.

Expand All @@ -100,5 +100,3 @@ jk@host ~ % ./setup.v2.sh --universal
# Directory ./querypie/ does not exist. QueryPie has not been installed on this system.
Do you want to install QueryPie (11.1.1)?
```


8 changes: 3 additions & 5 deletions src/content/ko/installation/installation/installation-guide-setupv2sh.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ $

### setup.v2.sh 가 자동으로 수행하는 작업

`setup.v2.sh` 는 다음의 주요 설치 절차를 자동으로 진행합니다.
`setup.v2.sh` 는 다음의 주요 설치 절차를 자동으로 수행합니다.

1. `docker-compose.yml` , `.env` 등 Compose 를 위한 설정파일을 내려 받기
* 기존의 `compose-env` 라는 환경변수 설정 파일의 이름이 `.env` 로 바뀌었습니다. `compose-env` 는 설정파일 생성을 위한 template 으로 사용됩니다.
Expand Down Expand Up @@ -163,7 +163,7 @@ $

`setup.v2.sh` 의 실행 마지막에 보이는 `http://172.31.11.201:8000` 와 같은 URL 에 접속을 시도하여 보십시오.
이 주소는 Local PC 에서 Linux Server 로 연결하기 위한 IP Address 를 사용합니다.
네트워크 연결 구성을 참조하여, Firewall, AWS Security Group 설정 등을 변경하여야 할 수 있습니다: [시스템 아키텍처와 네트워크 접근제어](../system-architecture-and-network-access-control)
네트워크 연결 구성을 참조해 Firewall, AWS Security Group 설정 등을 변경해야 할 수 있습니다: [시스템 아키텍처와 네트워크 접근제어](../system-architecture-and-network-access-control)

### License 입력하기

Expand All @@ -178,7 +178,5 @@ Enter the license in PEM format.

## 기본 설정 절차

설치가 완료된 후, 운영 환경에 맞게 초기 설정을 진행하여야 합니다.
설치가 완료된 후 운영 환경에 맞게 초기 설정을 진행해야 합니다.
자세한 설정 절차는 다음 문서를 참조하세요: [설치 후 초기 설정](../post-installation-setup)


6 changes: 2 additions & 4 deletions ...ontent/ko/installation/installation/installation-guide-simple-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Login Succeeded
`./setup.sh` 스크립트를 실행하면, `querypie/<version>/` 디렉토리 안에 `docker-compose.yml`, `compose-env` 등 설정 파일을 생성하게 됩니다.
이 디렉토리 안으로 이동하여, `compose-env` 라는 이름의 설정 파일을 편집합니다.

각 환경변수에 대한 설명은 다음 문서를 참조하여 주세요: [컨테이너 환경변수](../container-environment-variables)
각 환경변수에 대한 설명은 다음 문서를 참조해 주세요: [컨테이너 환경변수](../container-environment-variables)
```bash
# Version of QueryPie Docker Image to run: 10.3.0 or later.
VERSION=10.3.0
Expand Down Expand Up @@ -298,7 +298,5 @@ READYZ | '--------------------------------------------------------'

## 기본 설정 절차

설치가 완료된 후, 운영 환경에 맞게 초기 설정을 진행하여야 합니다.
설치가 완료된 후 운영 환경에 맞게 초기 설정을 진행해야 합니다.
자세한 설정 절차는 다음 문서를 참조하세요: [설치 후 초기 설정](../post-installation-setup)


8 changes: 4 additions & 4 deletions src/content/ko/installation/installation/installing-on-aws-eks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ helm repo list
<Callout type="info">
**참고** : 아래 예시는 Docker Hub를 사용하는 사례를 기준으로 합니다.
Harbor Registry 사용 시 `registry: harbor.chequer.io`로 변경하세요.
설치할 제품 버전은 [제품 버전](../product-versions) 문서를 참조하여 지정하세요.
설치할 제품 버전은 [제품 버전](../product-versions) 문서를 참조해 지정하세요.
</Callout>
```yaml
# -- appVersion: QueryPie version to install. This is an example value.
Expand Down Expand Up @@ -594,13 +594,13 @@ kubectl logs pod/poc-querypie-0 -f
kubectl port-forward -n querypie statefulsets/poc-querypie 80:80
```

이후, 처음 설정 과정을 진행합니다.
이후, 초기 설정을 수행합니다.

* [라이선스 설치](../license-installation)
* [설치 후 초기 설정](../post-installation-setup)문서를 참조하여 공통 설정, 제품별 설정을 진행합니다.
* [설치 후 초기 설정](../post-installation-setup) 문서를 참조해 공통 설정과 제품별 설정을 수행합니다.

이것으로 제품 설치 과정이 완료되었습니다.
수고하셨습니다~!
수고하셨습니다.

### 5. 문제 해결 가이드

Expand Down
3 changes: 1 addition & 2 deletions src/content/ko/installation/license-installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ ubuntu@querypie:~/querypie/10.2.4$
### 사용 중인 QueryPie 의 라이선스를 교체하는 경우 <Badge color="grey">Deprecated</Badge>

QueryPie 의 License 관리 기능에는 한 가지 제약사항이 있어서, 기존 라이선스의 유효기간과 새 라이선스의 유효기간이 일부 겹치는 경우, 새 라이선스를 추가로 설치하지 못합니다.
이로 인해, 유효기간이 겹치는 라이선스를 설치하려는 경우, 별도 절차를 통해 기존 라이선스를 삭제한 후, 새로운 라이선스를 설치하여야 합니다.
이로 인해 유효기간이 겹치는 라이선스를 설치하려는 경우, 별도 절차를 통해 기존 라이선스를 삭제한 후 새로운 라이선스를 설치해야 합니다.

<Callout type="important">
11.3.0 또는 이후 버전에는 이 제약이 해소되었습니다.
Expand Down Expand Up @@ -225,4 +225,3 @@ ubuntu@querypie:~/querypie/10.2.4$
지금까지, 기존 라이선스를 교체하여, 새로운 라이선스를 설치하는 과정을 살펴보았습니다.
수고하셨습니다.


Loading
Loading