diff --git a/docs/ko/guide/access-token.md b/docs/ko/guide/access-token.md new file mode 100644 index 0000000..ac79d28 --- /dev/null +++ b/docs/ko/guide/access-token.md @@ -0,0 +1,31 @@ +--- +title: "RustFS 액세스 키 관리" +description: "RustFS 액세스 키 생성, 사용 및 삭제" +--- + +# 액세스 키 + +RustFS 액세스 키는 신원 인증과 작업 권한 부여를 위한 핵심 자격 증명입니다. API 및 SDK 시나리오에서 특히 유용합니다. 이 문서는 액세스 키의 생성과 삭제를 설명합니다. + +사전 준비: + +- 사용 가능한 RustFS 인스턴스. [설치 가이드](../../ko/installation/index.md)를 참고하세요. + +## 액세스 키 생성 + +1. RustFS UI 콘솔에 로그인합니다. +1. 왼쪽 내비게이션에서 "액세스 키"를 선택합니다. +1. 액세스 키 페이지의 우측 상단에서 "액세스 키 추가"를 클릭합니다. +1. "만료 시간, 이름, 설명"을 입력한 후 "제출"을 클릭합니다. +1. (선택이지만 권장) 표시된 액세스 키 페이지에서 "복사" 또는 "내보내기"를 선택하여 안전하게 보관합니다. + +![access key list page](images/access_token_creation.png) + +## 액세스 키 삭제 + +1. RustFS UI 콘솔에 로그인합니다. +1. 왼쪽 내비게이션에서 "액세스 키"를 선택합니다. +1. 삭제할 액세스 키를 선택합니다. +1. 항목 우측의 "삭제" 또는 우측 상단의 "선택 항목 삭제"를 클릭합니다. + +![access key deletion](images/access_token_deletion.png) \ No newline at end of file diff --git a/docs/ko/guide/bucket/bucket-create-and-delete.md b/docs/ko/guide/bucket/bucket-create-and-delete.md new file mode 100644 index 0000000..ac1dc7d --- /dev/null +++ b/docs/ko/guide/bucket/bucket-create-and-delete.md @@ -0,0 +1,96 @@ +--- +title: "RustFS 버킷 관리" +description: "RustFS 버킷 생성과 삭제" +--- + +# RustFS 버킷 + +버킷은 RustFS에서 데이터를 구성하고 관리하는 기본 논리 컨테이너입니다. 각 버킷은 고유한 이름을 가지며 여러 객체를 포함할 수 있습니다. RustFS UI, `mc`(MinIO Client), API를 통해 버킷을 생성/삭제하고 데이터를 업로드/다운로드할 수 있습니다. + +## 버킷 생성 + +사전 준비: + +- 사용 가능한 RustFS 인스턴스 (../../installation/index.md 참조) + +## RustFS UI에서 생성 + +1. RustFS UI 콘솔에 로그인합니다. +1. 홈 좌상단에서 "버킷 생성"을 클릭합니다. +1. 버킷 이름을 입력하고 "생성"을 클릭합니다. + +![bucket creation](images/bucket-creation-by-ui.png) + +### `mc`로 생성 + +> 설치/설정은 [`mc` 가이드](../mc.md)를 참조하세요. + +``` +# creat rustfs bucket +mc mb rustfs/bucket-creation-by-mc +Bucket created successfully `rustfs/bucket-creation-by-mc`. + +# confirm bucket creation +mc ls rustfs/bucket-creation-by-mc +``` + +### API로 생성 + +``` +PUT /{bucketName} HTTP/1.1 +``` + +요청 예시: + +``` +curl --location --request PUT 'http://12.34.56.78:9000/bucket-creation-by-api' \ +--header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \ +--header 'X-Amz-Date: 20250801T023519Z' \ +--header 'Authorization: AWS4-HMAC-SHA256 Credential=H4xcBZKQfvJjEnk3zp1N/20250801/cn-east-1/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=c2fb2ba5199a30ebcfa9976d0f35000ba274da3701327957e84ea0f3920288f2' +``` + +UI에서 `bucket-creation-by-api` 버킷이 생성되었음을 확인할 수 있습니다. + +## 버킷 삭제 + +주의: 버킷 삭제는 버킷을 사용하는 애플리케이션에 오류를 유발할 수 있습니다. 삭제 전 데이터 백업 및 불필요 여부를 확인하세요. + +### RustFS UI에서 삭제 + +1. RustFS UI 콘솔에 로그인합니다. +1. 홈에서 삭제할 버킷을 선택합니다. +1. 우측의 "삭제" 버튼을 클릭합니다. +1. 대화상자에서 "확인"을 클릭합니다. + +![bucket deletion](images/bucket-deletion-on-ui.png) + +### `mc`로 삭제 + +> [`mc` 가이드](../mc.md) 참조. + +``` +# delete bucket +mc rb rustfs/bucket-creation-by-mc +Removed `rustfs/bucket-creation-by-mc` successfully. + +# confirm bucket deletion +mc ls rustfs/bucket-creation-by-mc +mc: Unable to list folder. Bucket `bucket-creation-by-mc` does not exist. +``` + +### API로 삭제 + +``` +DELETE /{bucketName} HTTP/1.1 +``` + +요청 예시: + +``` +curl --location --request DELETE 'http://12.34.56.78:9000/bucket-creation-by-api' \ +--header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \ +--header 'X-Amz-Date: 20250801T024406Z' \ +--header 'Authorization: AWS4-HMAC-SHA256 Credential=H4xcBZKQfvJjEnk3zp1N/20250801/cn-east-1/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=d0f6addf09fffd7eef75191e9d3209bb7188e6b004e9707238fc60ad7033edae' +``` + +RustFS UI에서 `bucket-creation-by-api` 버킷이 삭제되었음을 확인할 수 있습니다. \ No newline at end of file diff --git a/docs/ko/guide/bucket/images/bucket-creation-by-ui.png b/docs/ko/guide/bucket/images/bucket-creation-by-ui.png new file mode 100644 index 0000000..4eb368f Binary files /dev/null and b/docs/ko/guide/bucket/images/bucket-creation-by-ui.png differ diff --git a/docs/ko/guide/bucket/images/bucket-deletion-on-ui.png b/docs/ko/guide/bucket/images/bucket-deletion-on-ui.png new file mode 100644 index 0000000..099655a Binary files /dev/null and b/docs/ko/guide/bucket/images/bucket-deletion-on-ui.png differ diff --git a/docs/ko/guide/bucket/images/delete_file_from_ui.png b/docs/ko/guide/bucket/images/delete_file_from_ui.png new file mode 100644 index 0000000..24ab021 Binary files /dev/null and b/docs/ko/guide/bucket/images/delete_file_from_ui.png differ diff --git a/docs/ko/guide/bucket/images/object_details_info.png b/docs/ko/guide/bucket/images/object_details_info.png new file mode 100644 index 0000000..2524e14 Binary files /dev/null and b/docs/ko/guide/bucket/images/object_details_info.png differ diff --git a/docs/ko/guide/bucket/images/upload_file_from_ui.png b/docs/ko/guide/bucket/images/upload_file_from_ui.png new file mode 100644 index 0000000..0ddd76a Binary files /dev/null and b/docs/ko/guide/bucket/images/upload_file_from_ui.png differ diff --git a/docs/ko/guide/bucket/object-upload-and-delete.md b/docs/ko/guide/bucket/object-upload-and-delete.md new file mode 100644 index 0000000..b723a33 --- /dev/null +++ b/docs/ko/guide/bucket/object-upload-and-delete.md @@ -0,0 +1,103 @@ +--- +title: "RustFS 객체 관리" +description: "객체 업로드와 삭제" +--- + +# RustFS 객체 + +객체(Object)는 RustFS 저장의 기본 단위로, 데이터, 메타데이터, 고유 식별자(Object Key)로 구성됩니다. 본 문서는 파일 업로드와 삭제 예시를 통해 객체 관리를 설명합니다. + +> 객체 관련 개념은 [핵심 개념](../../concepts/glossary.md)을 참고하세요. + +## 객체 생성 + +사전 준비: + +- 사용 가능한 RustFS 인스턴스 (../../installation/index.md 참조) + +[버킷 생성](bucket-create-and-delete.md) 후 해당 버킷으로 파일을 업로드하면 객체가 생성됩니다. RustFS UI, `mc`, API로 업로드할 수 있습니다. + +### RustFS UI로 업로드 + +1. RustFS UI 콘솔에 로그인합니다. +1. 업로드할 버킷을 선택합니다. +1. 버킷 페이지 우측 상단에서 "새 디렉토리", "새 파일", "파일/폴더 업로드"를 선택합니다. +1. 로컬 업로드의 경우 "파일/폴더 업로드"를 클릭해 항목을 선택한 후 "업로드 시작"을 클릭합니다. + +![object creation from ui](images/upload_file_from_ui.png) + +업로드 후 객체를 클릭하면 상세 정보를 볼 수 있습니다. + +![object details info](images/object_details_info.png) + +### `mc`로 업로드 + +> 설치/설정은 [`mc` 가이드](../mc.md)를 참고하세요. + +``` +# upload file +mc cp 1.txt rustfs/bucket-creation-by-mc +/tmp/1.txt: 13 B / 13 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 61 B/s 0s% + +# confirm file uploaded +mc ls rustfs/bucket-creation-by-mc +[2025-08-01 10:01:08 CST] 13B 1.txt +``` + +### API로 업로드 + +``` +PUT /{bucketName}/{objectName} HTTP/1.1 +``` + +요청 예시: + +``` +curl --location --request PUT 'http://12.34.56.78:9000/bucket-creation-by-api/password.txt' \ +--header 'Content-Type: text/plain' \ +--header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \ +--header 'X-Amz-Date: 20250801T024840Z' \ +--header 'Authorization: AWS4-HMAC-SHA256 Credential=H4xcBZKQfvJjEnk3zp1N/20250801/cn-east-1/s3/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-content-sha256;x-amz-date, Signature=b7d8dc29ee34dfdf1f3e9e8e069892a8936f478586e7a2c90cf34f5b86d3a2dc' \ +--data-binary '@/path/to/password.txt' +``` + +## 객체 삭제 + +UI, `mc`, API로 객체를 삭제할 수 있습니다. 위에서 업로드한 파일을 삭제해 봅니다. + +## RustFS UI로 삭제 + +1. RustFS UI 콘솔에 로그인합니다. +1. 파일이 있는 버킷을 선택합니다. +1. 삭제할 파일을 선택합니다. +1. 우측 상단의 "선택 항목 삭제"를 클릭하고 확인합니다. + +![object deletion from ui](images/delete_file_from_ui.png) + +### `mc`로 삭제 + +``` +# delete file +mc rm rustfs/bucket-creation-by-mc/1.txt +Removed `rustfs/bucket-creation-by-mc/1.txt`. + +# confirm deletion +mc ls rustfs/bucket-creation-by-mc/1.txt +``` + +### API로 삭제 + +``` +DELETE /{bucketName}/{objectName} HTTP/1.1 +``` + +요청 예시: + +``` +curl --location --request DELETE 'http://12.34.56.78:9000/bucket-creation-by-api/password.txt' \ +--header 'Content-Type: text/plain' \ +--header 'X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' \ +--header 'X-Amz-Date: 20250801T030822Z' \ +--header 'Authorization: AWS4-HMAC-SHA256 Credential=H4xcBZKQfvJjEnk3zp1N/20250801/cn-east-1/s3/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-content-sha256;x-amz-date, Signature=1ee63bb0b699598602b2fdbd013e355a57bcb9991307a8ad41f6512e8afebf3a' \ +--data-binary '@/Users/jhma/Desktop/password.txt' +``` \ No newline at end of file diff --git a/docs/ko/guide/images/access_token_creation.png b/docs/ko/guide/images/access_token_creation.png new file mode 100644 index 0000000..fbc3ce1 Binary files /dev/null and b/docs/ko/guide/images/access_token_creation.png differ diff --git a/docs/ko/guide/images/access_token_deletion.png b/docs/ko/guide/images/access_token_deletion.png new file mode 100644 index 0000000..1575270 Binary files /dev/null and b/docs/ko/guide/images/access_token_deletion.png differ diff --git a/docs/ko/guide/mc.md b/docs/ko/guide/mc.md new file mode 100644 index 0000000..e410f18 --- /dev/null +++ b/docs/ko/guide/mc.md @@ -0,0 +1,104 @@ +--- +title: "MinIO Client로 RustFS 객체 관리" +description: "MinIO Client를 사용하여 RustFS 객체를 관리" +--- + +# MinIO Client (`mc`) + +MinIO Client(`mc`)는 MinIO가 제공하는 공식 CLI 도구로, MinIO, Amazon S3 및 S3 호환 오브젝트 스토리지와 상호 작용합니다. S3 호환인 RustFS도 `mc`로 관리할 수 있습니다. + +사전 준비: + +- RustFS 인스턴스 (../../ko/installation/index.md) +- `mc` 설치됨 +- 사용 가능한 [액세스 키](access-token.md) + +## `mc`로 RustFS 사용하기 + +먼저 `mc alias` 명령으로 RustFS 별칭을 설정합니다: + +``` +mc alias set rustfs http://12.34.56.78:9000 ACCESS_KEY SECRET_KEY +``` + +응답: + +``` +Added `rustfs` successfully. +``` + +이후 `rustfs` 별칭으로 버킷 생성/삭제, 파일 업/다운로드를 수행할 수 있습니다. + +### 버킷 목록 조회 + +``` +mc ls rustfs +``` + +응답: + +``` +[2025-08-01 10:46:24 CST] 0B bucket-creation-by-api/ +[2025-07-29 09:15:35 CST] 0B rustfs-demo/ +[2025-08-03 09:44:45 CST] 0B bucket-creation-by-ui/ +``` + +### 버킷 생성 + +``` +mc mb rustfs/bucket-creation-by-mc +``` + +응답: + +``` +Bucket created successfully `rustfs/bucket-creation-by-mc`. +``` + +### 버킷 삭제 + +``` +mc rb rustfs/bucket-creation-by-mc +``` + +응답: + +``` +Removed `rustfs/bucket-creation-by-mc` successfully. +``` + +### 파일 업로드 + +``` +mc cp file_name rustfs/bucket-creation-by-mc +``` + +응답: + +``` +...path/to/file_name: 4 B / 4 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 12 B/s 0s% +``` + +### 파일 삭제 + +``` +mc rm rustfs/bucket-creation-by-mc/file_name +``` + +응답: + +``` +Removed `rustfs/bucket-creation-by-mc/1.txt`. +``` + +### 파일 다운로드 + +``` +mc get rustfs/bucket-creation-by-mc/file_name ./file_name +``` + +응답: + +``` +...eation-by-mc/file_name: 4 B / 4 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 18 B/s 0s% +``` \ No newline at end of file