Skip to content
Open
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
3 changes: 1 addition & 2 deletions src/content/ko/user-manual.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ confluenceUrl: 'https://querypie.atlassian.net/wiki/spaces/QM/pages/544211126'

### 환영합니다.

이곳에서 QueryPie의 사용자가 어떻게 QueryPie Web에 접속하여 리소스(DB, System, Cluster)에 대한 접근 권한을 받고, 원하는 리소스에 안전하게 접속할 수 있는지에 대한 가이드를 제공합니다.
이 문서에서는 QueryPie 사용자가 QueryPie Web에 접속해 리소스(DB, System, Cluster) 접근 권한을 받고, 원하는 리소스에 안전하게 접속하는 방법을 안내합니다.


### QueryPie가 처음이신가요?
Expand Down Expand Up @@ -122,4 +122,3 @@ confluenceUrl: 'https://querypie.atlassian.net/wiki/spaces/QM/pages/544211126'
</tbody>
</table>


2 changes: 1 addition & 1 deletion src/content/ko/user-manual/database-access-control.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ QueryPie에서는 웹 브라우저를 통해 쿼리를 실행하고 데이터를

반면, **에이전트를 통한 프록시 접속** 의 경우, 개발자 또는 데이터 담당자들은 **기존에 사용하던 DB 접속 툴** 을 그대로 사용할 수 있습니다.
사용자의 데스크탑에 설치되는 에이전트는 데이터베이스와 클라이언트 사이에서 프록시 접속이 역할을 수행하여, 개발자들이 기존에 사용하던 DB 클라이언트 툴을 계속해서 사용할 수 있도록 지원합니다.
이를 통해 개발자들은 익숙한 도구를 사용하여 SQL 작업을 보다 편리하게 수행할 수 있으나, 클라이언트 툴에서 제공하는 **세부 기능에 대해서는 제어하기 어려운 부분** 이 있습니다.
이를 통해 개발자들은 익숙한 도구를 사용하여 SQL 작업을 보다 편리하게 수행할 수 있으나, 클라이언트 툴에서 제공하는 **세부 기능은 제어하기 어려운 부분** 이 있습니다.

**에이전트 없이 URL Proxy 를 통한 접속** 또한 지원합니다.
Redash, Tableau, Zepplin 과 같은 **웹 서비스에서 DB 에 연결하고자 할 때** , QueryPie 에서 생성된 URL Proxy 인증 정보를 통해 접근 통제 정책을 적용받으면서도 안전하게 데이터베이스에 접근이 가능합니다.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ import { Callout } from 'nextra/components'
3. Approval Rule을 상황에 맞게 설정하고 Title도 작성합니다.
4. DB Connection 목록에서 Type이 'Custom Data Source'인 항목을 선택합니다.
5. 다른 벤더들과 다르게 Privilege를 선택할 수 없기 때문에 “-”로 표기됩니다.
6. Expiration Date과 Reason for Request 항목도 상황에 맞게 설정 및 작성합니다. <br/>
6. Expiration Date와 Reason for Request 항목도 상황에 맞게 설정하고 작성합니다. <br/>
<figure data-layout="center" data-align="center">
<img src="/user-manual/database-access-control/connecting-to-custom-data-source/Screenshot-2025-03-06-at-1.22.28-PM.png" alt="Screenshot-2025-03-06-at-1.22.28-PM.png" width="712" />
</figure>
7. 작성을 완료했다면 하단 `Submit`버튼을 클릭하여 신청을 완료합니다.
7. 작성을 완료했다면 하단 `Submit` 버튼을 클릭해 신청을 완료합니다.
8. 관리자의 승인을 받았다면 좌측 Workflow &gt; Sent Request &gt; Done 메뉴에서 확인할 수 있습니다.

<Callout type="important">
Expand All @@ -41,7 +41,7 @@ import { Callout } from 'nextra/components'
</figure>
2. **Connection Guide 확인**
* Agent에서 Custom Data Source 커넥션 행을 클릭하면 Port 정보를 담은 행이 보입니다.
* 위 행을 우클릭을 한 뒤 Connection Guide를 클릭하면 접속 정보를 확인할 수 있습니다. <br/>
* 위 행을 우클릭한 뒤 Connection Guide를 클릭하면 접속 정보를 확인할 수 있습니다. <br/>
<figure data-layout="center" data-align="center">
<img src="/user-manual/database-access-control/connecting-to-custom-data-source/Screenshot-2025-03-06-at-2.08.11-PM.png" alt="Screenshot-2025-03-06-at-2.08.11-PM.png" width="712" />
</figure>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { Callout } from 'nextra/components'
### Overview

에이전트 없이 URL Proxy를 통한 접속 또한 지원합니다.
Redash, Tableau, Zepplin 과 같은 웹 서비스에서 DB에 연결하고자 할 때, QueryPie에서 생성된 URL Proxy 인증 정보를 통해 접근 통제 정책을 적용받으면서도 안전하게 데이터베이스에 접근이 가능합니다.
Redash, Tableau, Zeppelin과 같은 웹 서비스에서 DB에 연결할 때 QueryPie에서 생성된 URL Proxy 인증 정보를 통해 접근 통제 정책을 적용받으면서 안전하게 데이터베이스에 접근할 수 있습니다.


### URL Proxy 인증 정보 수령하기
Expand All @@ -30,7 +30,7 @@ QueryPie Web &gt; Data Access Control &gt; Databases &gt; Proxy Info

1. QueryPie 로그인 후 상단 메뉴 바 옵션에서 `Databases`를 클릭합니다.
2. 우측 상단의 `Proxy Info`를 클릭합니다.
3. 사용하고자 하는 서비스에 **Proxy Host** 및 **Proxy Port** 를 복사하여 실제 DB에 대한 호스트 대신 기입합니다.
3. 사용하려는 서비스에 **Proxy Host** 및 **Proxy Port**를 복사해 실제 DB 호스트 대신 입력합니다.
4. 하단의 `Create Token` 버튼을 클릭하여 사용자 인증 토큰을 발급받습니다.

<figure data-layout="center" data-align="center">
Expand All @@ -40,5 +40,5 @@ QueryPie Web &gt; Data Access Control &gt; Databases &gt; Proxy Info &gt; Create
</figcaption>
</figure>

1. 해당 팝업창에서 제공하는 **Username** 및 **Password** 를 사용하고자 하는 서비스에 기입하여 쿼리파이 프록시를 통한 연결을 활성화합니다. (해당 사용자 인증 토큰 정보는 최초 발급 시에만 전체 노출됩니다)
2. 만약 토큰 키를 분실한 경우 기존 키를 내역에서 `Revoke` 버튼을 클릭하여 삭제하고, 다시 `Create Token`버튼을 클릭하여 토큰을 새로 발급받아 사용하시면 됩니다.
1. 해당 팝업에서 제공하는 **Username** 및 **Password**서비스에 입력해 QueryPie 프록시 연결을 활성화합니다. (해당 사용자 인증 토큰 정보는 최초 발급 시에만 전체 노출됩니다.)
2. 토큰 키를 분실한 경우 기존 키를 내역에서 `Revoke` 버튼으로 삭제하고, `Create Token` 버튼을 다시 클릭해 새 토큰을 발급받아 사용합니다.
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ import { Callout } from 'nextra/components'

### Overview

QueryPie 관리자가 BigQuery 커넥션 인증 방식을 OAuth 2.0으로 설정한 경우 접속할 때 본인의 Google 계정으로 접속할 수 있습니다.
QueryPie 관리자가 BigQuery 커넥션 인증 방식을 OAuth 2.0으로 설정한 경우, 접속 시 본인의 Google 계정으로 로그인할 수 있습니다.

### Google 계정으로 로그인하기

1. QueryPie 사용자 페이지의 Database 항목 아래의 커넥션 목록에서 BigQuery 커넥션을 선택합니다.<br/>(관리자로부터 접근이 허용되어야 커넥션 목록에서 수 있습니다.)<br/>
1. QueryPie 사용자 페이지의 Database 항목 아래 커넥션 목록에서 BigQuery 커넥션을 선택합니다.<br/>(관리자로부터 접근이 허용되어야 커넥션 목록에서 확인할 수 있습니다.)<br/>
<figure data-layout="center" data-align="center">
<img src="/user-manual/database-access-control/connecting-via-google-bigquery-oauth-authentication/image-20250226-020846.png" alt="사용자 페이지 Database의 커넥션 목록에서 보이는 BigQuery 커넥션" width="760" />
<figcaption>
Expand Down Expand Up @@ -43,7 +43,7 @@ QueryPie 관리자가 BigQuery 커넥션 인증 방식을 OAuth 2.0으로 설정
OAuth 인증 방식은 사용자가 로그인할 때 access token과 refresh token을 발급받습니다.
이후 access token의 기한이 만료되면 refresh token을 사용해서 access token을 재발급받습니다.
refresh token은 각 클라이언트에 저장됩니다.
refresh token도 만료가 있을 수 있고 여러 가지 원인에 의해 클라이언트에 저장된 refresh token이 유효하지 않은 상황이 발생할 수 있습니다.
refresh token도 만료될 수 있고 여러 원인으로 인해 클라이언트에 저장된 refresh token이 유효하지 않은 상황이 발생할 수 있습니다.
이럴 때 클라이언트에 저장되어 있는 refresh token을 삭제하고 재발급을 받을 필요가 있습니다.
</Callout>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ User &gt; Databases의 커넥션 선택 및 접속 화면

1. QueryPie 로그인 후 상단 메뉴 바 옵션에서 `Databases`를 클릭합니다.
2. 좌측 패널에 접속 가능한 데이터베이스 커넥션들이 표시됩니다.
3. 접속하고자 하는 커넥션을 클릭하면 우측에 세부 정보가 표시되며, `Connect`버튼을 클릭하여 접속합니다.
3. 접속하려는 커넥션을 클릭하면 우측에 세부 정보가 표시되며, `Connect` 버튼을 클릭해 접속합니다.

필요한 커넥션이 표시되지 않는 경우, Workflow &gt; DB Access Request를 통해 접근 권한을 요청할 수 있습니다.

Expand Down Expand Up @@ -80,7 +80,7 @@ QueryPie Web &gt; Database Access Control &gt; SQL Editor &gt; Toolbar
* `Undo` : 작성 중인 쿼리 기준으로 실행 취소할 수 있습니다.
* `Redo` : 실행 취소한 작업을 다시 실행할 수 있습니다.
* `Format` : 작성 중인 쿼리를 정렬할 수 있습니다.
* `Auto commit` : 수행한 작업 쿼리를 자동으로 커밋을 활성화합니다.
* `Auto commit` : 수행한 작업 쿼리의 자동 커밋을 활성화합니다.
* `Commit` : 수행한 작업 쿼리를 수동으로 확정합니다.
* `List` : 작업 확정되지 않은 쿼리 목록을 나열합니다.
* `Rollback` : 직전 커밋 직후의 단계로 회귀를 수행합니다.
Expand Down Expand Up @@ -165,7 +165,7 @@ SQL Editor &gt; SQL History Panel

#### 6. 쿼리 수행 시 사유입력

Ledger 정책 또는 커넥션 정책에 의해 쿼리를 수행 시 사유입력이 강제될 수 있습니다.
Ledger 정책 또는 커넥션 정책에 의해 쿼리 수행 시 사유 입력이 강제될 수 있습니다.
이 경우 사용자가 쿼리를 입력하면 사유를 입력하는 팝업이 출력됩니다.
아래 그림과 같이 “Write the reason for this request” 팝업 대화창에 쿼리를 수행하는 사유를 입력하고 `OK` 버튼을 누르면 쿼리 실행 결과가 출력됩니다.
총 300자까지 입력 가능합니다.
Expand All @@ -174,4 +174,3 @@ Ledger 정책 또는 커넥션 정책에 의해 쿼리를 수행 시 사유입
<img src="/user-manual/database-access-control/connecting-with-web-sql-editor/image-20241031-233232.png" alt="image-20241031-233232.png" width="760" />
</figure>


Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ QueryPie Web &gt; Database Access Control &gt; Databases &gt; Privileges &gt; De

<Callout type="important">
* 부여받은 권한이 2개 이상이지만 Default Privilege 설정이 안 되어 있는 경우에는 가장 먼저 grant된 privilege가 default privilege가 됩니다. 에이전트 프록시, SQL Request, Export Request에서 접속 시 Default Privilege로 선택된 권한으로 DB에 접속합니다.
* Default Privilege 변경은 웹과 Multi-Agent에서 제공합니다. User Agent에서는 Default Privilege 변경 기능은 제공하지 않으며, 사용자는 접속할 Privilege를 변경하고자 하는 경우 웹페이지에서 변경하여야 합니다.
* Default Privilege 변경은 웹과 Multi-Agent에서 제공합니다. User Agent에서는 Default Privilege 변경 기능을 제공하지 않으므로, 접속할 Privilege를 변경하려면 웹페이지에서 변경해야 합니다.
* Default Privilege로 커넥션에 이미 접속되어 있는 상태에서 Default Privilege를 변경한 경우 또는 해당 권한을 회수한 경우, 기존 세션은 Disconnect 처리하고 새로운 Default 권한으로 새로 Connect 처리합니다.
* 부여받은 권한이 2개 이상인 경우 Default privilege 설정이 되어 있지 않고 privilege deactivation period 초과로 inactive 상태가 된 경우 agent를 통해 접속할 수 없습니다. Default privilege가 설정되어 있어도 상태가 privilege deactivation period 초과로 inactive 인 경우 접속할 수 없습니다.
</Callout>
5 changes: 2 additions & 3 deletions src/content/ko/user-manual/kubernetes-access-control.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ confluenceUrl: 'https://querypie.atlassian.net/wiki/spaces/QM/pages/544384011/Ku

### Overview

QueryPie는 쿠버네티스 클러스터에 대한 접근권한을 제어하고, 쿠버네티스 클러스터에 접속한 사용자의 Activity를 감사로그로 기록하는 기능을 제공합니다.
쿼리파이 에이전트를 통해 권한을 부여받은 클러스터에 접속할 수 있고, 클러스터 접속에 필요한 KUBECONFIG 파일은 에이전트를 통해 구성됩니다.
QueryPie는 쿠버네티스 클러스터에 대한 접근 권한을 제어하고, 쿠버네티스 클러스터에 접속한 사용자의 Activity를 감사 로그로 기록하는 기능을 제공합니다.
QueryPie Agent를 통해 권한이 부여된 클러스터에 접속할 수 있으며, 클러스터 접속에 필요한 `KUBECONFIG` 파일은 Agent를 통해 구성됩니다.

<figure data-layout="center" data-align="center">
<img src="/user-manual/kubernetes-access-control/image-20240724-050502.png" alt="QueryPie Web &gt; Kubernetes Access Control &gt; Kubernetes" width="760" />
Expand All @@ -22,4 +22,3 @@ QueryPie Web &gt; Kubernetes Access Control &gt; Kubernetes

* [접근 권한 목록 확인하기](kubernetes-access-control/checking-access-permission-list)


Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { Callout } from 'nextra/components'

### Overview

사용자는 권한이 있는 쿠버네티스 클러스터의 목록을 Cloud Provider별로 정렬하여 한눈에 확인하고, 쿠버네티스 API 호출에 대한 접근을 도와줄 전용 QueryPie 에이전트를 다운로드받아 설치할 수 있습니다.
사용자는 권한이 있는 쿠버네티스 클러스터 목록을 Cloud Provider별로 정렬해 한눈에 확인하고, 쿠버네티스 API 호출을 지원하는 전용 QueryPie Agent를 다운로드해 설치할 수 있습니다.

### Role 선택하기

Expand All @@ -29,7 +29,7 @@ QueryPie Web &gt; System Access Control &gt; Kubernetes &gt; Select a Role
</figcaption>
</figure>

1. Kubernetes 메뉴로 첫 접속 시 표시되는 Role 선택 화면에서 권한 확인을 원하는 Role을 선택합니다.
1. Kubernetes 메뉴에 처음 접속하면 표시되는 Role 선택 화면에서 권한 확인을 원하는 Role을 선택합니다.
1. Role에 따라 접근 권한이 다르며, 부여된 Role이 없는 경우 왼쪽 목록이 표시되지 않습니다.
2. 이 경우 Workflow 메뉴의 Access Role Request 양식을 통해 적절한 권한을 신청할 수 있습니다.

Expand Down
3 changes: 1 addition & 2 deletions src/content/ko/user-manual/multi-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ QueryPie Multi Agent는 여러 개의 QueryPie Host를 동시에 사용할 수

Agent UI에서는 특정 Host에서 사용 가능한 리소스들을 확인할 수 있습니다.

Agent 설치 및 Host별 로그인 수행만으로 추가 설정 없이 둘 이상의 QueryPie Proxy를 통한 리소스 접속이 가능합니다.
Agent 설치 및 Host별 로그인 수행만으로 추가 설정 없이 둘 이상의 QueryPie Proxy를 통한 리소스에 접속할 수 있습니다.

<Callout type="info">
**지원 버전**
Expand Down Expand Up @@ -404,4 +404,3 @@ set QPMA_TRACE=1 "%ProgramFiles%\QueryPie Multi Agent\QueryPieMultiAgent.exe"

[Multi Agent 제약사항](../administrator-manual/multi-agent-limitations)


Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ QueryPie Multi Agent에서 지원되는 3rd Party Tool 목록입니다.

Open Connection With 기능을 통해 3rd Party Tool을 실행하고, 정상적으로 사용 가능한 툴 목록입니다.

Agentless 형태의 연결을 통해 지원되는 Tool 외에도, DB 또는 서버에 접속이 가능합니다.
Agentless 형태의 연결을 통해 지원되는 Tool 외에도 DB 또는 서버에 접속할 수 있습니다.


### Database
Expand Down Expand Up @@ -61,7 +61,7 @@ QueryPie는 에이전트 없이 생성된 URL Proxy를 통해 안전하게 데
<Callout type="info">
**Seamless SSH 연결**

Seamless SSH 설정을 통해서, 다른 Tool에서도 QueryPie를 통한 서버로의 안전한 접속이 가능합니다.
Seamless SSH 설정을 통해 다른 Tool에서도 QueryPie를 통한 서버로 안전하게 접속할 수 있습니다.

자세한 설정 방법은 [Multi Agent Seamless SSH 사용 가이드](multi-agent-seamless-ssh-usage-guide) 가이드를 참고해주세요.
</Callout>
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ QueryPie Multi Agent는 FreeDesktop 환경의 Linux 플랫폼에서만 동작합
| RedHat | RHEL | 8 (Ootpa) | - |
| RedHat | CentOS | 8.0 | - |

* *최소 지원 버전: glibc 2.27 을 지원하는 최소 Linux 버전*
* *최소 지원 버전: glibc 2.27을 지원하는 최소 Linux 버전*

## 설치 및 삭제 방법

Expand All @@ -32,9 +32,9 @@ QueryPie Web &gt; 프로필 &gt; Multi-Agent 를 통해 Multi Agent 설치 파

### 선행 작업

Multi Agent는 [StatusNotifierItem](https://www.freedesktop.org/wiki/Specifications/StatusNotifierItem/) 으로 트레이 아이콘 기능을 제공합니다.
Multi Agent는 [StatusNotifierItem](https://www.freedesktop.org/wiki/Specifications/StatusNotifierItem/)을 통해 트레이 아이콘 기능을 제공합니다.

다양한 리눅스 배포판에서 StatusNotifierItem 이 기본으로 노출되지 않을 수 있습니다.
다양한 리눅스 배포판에서는 StatusNotifierItem이 기본으로 노출되지 않을 수 있습니다.

#### 1. 설치 확인

Expand Down Expand Up @@ -216,4 +216,3 @@ Default Browser를 설정하지 않으면 링크가 열리지 않습니다.
</figure>



Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Seamless SSH란 기존 터미널 사용성을 그대로 유지하면서 QueryPie

#### SSH config 설정 방법

기존의 `ssh` 명령어를 사용하기 위하여 SSH config 파일을 설정할 수 있습니다.
기존 `ssh` 명령어를 사용하기 위해 SSH config 파일을 설정할 수 있습니다.


1. `.ssh` 디렉토리로 이동하여 `config` 파일을 생성하거나 편집합니다.
Expand Down Expand Up @@ -46,7 +46,7 @@ ssh {{Server Account}}@{{Server Name}}

#### Shell Alias 설정 방법

기존의 `ssh` 명령어를 사용하기 위하여 SSH Alias 를 설정할 수 있습니다.
기존 `ssh` 명령어를 사용하기 위해 SSH Alias를 설정할 수 있습니다.


1. 쉘 설정 파일을 엽니다.
Expand Down Expand Up @@ -103,7 +103,7 @@ qpa ssh %r %h %p

#### 연결 에러 노출 방식

연결 단계에서 QueryPie Proxy 서버에 연결에 오류가 발생하면 기존 User Agent는 dialog 를 표시하고 있어 터미널 친화적이지 않았습니다.
연결 단계에서 QueryPie Proxy 서버 연결 오류가 발생하면 기존 User Agent는 dialog를 표시해 터미널 친화적이지 않았습니다.

Multi Agent는 **터미널에 에러 내용이 노출** 되도록 변경되었습니다.
```
Expand Down Expand Up @@ -179,7 +179,7 @@ $ qpctl host use nightly.dev.querypie.io

#### ⚠️ 실험적 기능 - qpctl 직접 사용 ⚠️

Seamless SSH 를 사용하기 위해
Seamless SSH를 사용하기 위해

* `~/.ssh/config` 를 설정하거나
* ssh 명령에 `-o ProxyCommand=qpctl ssh-proxy …` 를 입력하는
Expand Down
3 changes: 1 addition & 2 deletions src/content/ko/user-manual/my-dashboard.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ QueryPie 로그인 화면
#### 계정 정보 입력

* **SSO 로그인 버튼** : 관리자가 SSO(Single Sign-On) 설정을 한 경우 노출되며, 클릭 시 IdP 인증 페이지로 연결됩니다.
* **ID/PW 입력란** : QueryPie에 등록된 ID, 비밀번호를 입력 후 `Continue` 버튼을 눌러 로그인을 진행합니다.
* **ID/PW 입력란** : QueryPie에 등록된 ID와 비밀번호를 입력한 후 `Continue` 버튼을 눌러 로그인합니다.

<Callout type="info">
관리자가 Multi-Factor Authentication 설정을 한 경우, 사용자는 로그인 시 비밀번호를 입력한 뒤 관리자가 지정한 수단을 사용하여 2차 인증을 진행해야 합니다.
Expand Down Expand Up @@ -128,4 +128,3 @@ My Dashboard &gt; 우측 상단 메뉴
</figcaption>
</figure>


Loading
Loading