Skip to content

Commit

Permalink
Merge pull request #508 from m-yamanashi/add-v3-document
Browse files Browse the repository at this point in the history
Make corrections for the 4th division
  • Loading branch information
s-yama authored Dec 17, 2024
2 parents 5209fb6 + a3a538c commit cafbc0c
Show file tree
Hide file tree
Showing 12 changed files with 1,127 additions and 2 deletions.
38 changes: 38 additions & 0 deletions v3/en/docs/abci-objectstorage/account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@

# Accounts and Access Keys (Under Update)

## Object Storage Account

There are two types of accounts. The one is 'Object Storage Account for user' and the other is 'Object Storage Account for manager'. Object Storage Account for user is issued to each ABCI user per ABCI group. Both Object Storage Account for user and Object Storage Account for manager are issued to User Administrators.

### Object Storage Account for User

This account allows users to use ABCI Object Storage in general ways, such as uploading and downloading data. For example, 'aaa00000aa.1' is a name of a account.

If an ABCI user belongs to multiple groups and uses ABCI Object Storage from the other group, another Object Storage Account 'aaa0000aa.2' is given to the user.

Most of the time, having an Object Storage Account for a group is satisfying. However, if necessary, multiple Object Storage Accounts for a group are issued to a user. An additional Object Storage Account 'aaa00000aa.3', for example, is issued to the user for an application under development. ABCI users can not specify the name of accounts by themselves.

An ABCI user can own at most 10 Object Storage Accounts per group. If an ABCI user belongs to two groups, 20 Object Storage Accounts at most can be given to the user.

### Object Storage Account for Manager

This account is only given to User Administrators and allow them to control accessibility.

Even though User Administrators can use the 'Object Storage Account for managers' in order to perform what 'Object Storage Account for users' can do such as uploading or downloading data, it is basically supposed to use rather 'Object Storage Account for user' than 'Object Storage Account for manager' to do so.

The Object Storage Account for Manager is issued to every single User Administrator. If a user is a User Administrator for two groups, two accounts are given to her/him.

## Access Key

An access key is issued to every Object Storage account. Access keys consist of an access key ID and a secret access key. Secret access keys are not allowed to be disclosed to third parties or put somewhere accessible by third parties.

Object Storage account can have a maximum of two access keys. When using different clients, creating different access keys for each client is highly recommended.

## Account deletion

ABCI User Portal does not have a feature to delete ABCI Object Storage accounts at this time. Although deleting access keys is a way to prevent a user from accessing ABCI Object Storage, you can also request your ABCI Object Storage account be deleted. Read the [Contact](../contact.md) page, then send the ABCI Object Storage account name to <abci3-qa@abci.ai>.

!!! note
- Deleted accounts cannot be restored. Make sure that the Object Storage account name you wish to delete is correct.
- The suffix numbers which were assigned to deleted accounts will be vacant permanently. Since you can create 10 accounts per group, if you belong to only one group and delete one account, the last account number is 11 (e.g. "aaa00000aa.11"), not 10.
33 changes: 33 additions & 0 deletions v3/en/docs/abci-objectstorage/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# ABCI Object Storage (Under Upadate)

ABCI Object Storage Service offers an object storage service that has a compatible interface with Amazon Simple Storage Service (Amazon S3).

ABCI Object Storage has unique capabilities.

- Compatibility

Users store data into a globally unique bucket through the interface compatible with Amazon S3. Clients compatible with S3 such as AWS Command Line Interface (AWS CLI) and s3cmd are available. Users can also make client tools by using boto. Some APIs are not supported. The example of usage of AWS CLI is shown in another section.

- Accessibility

Users can access the storage not only from the computational nodes or interactive nodes but also from outside ABCI. In other words, ABCI users can use the storage as a data transferring tool that allows users to transfer data for computational jobs from outside ABCI.

- Encryptability

Users can encrypt data transfers between clients and the storage. Users can also encrypt data and store encrypted data in the storage.


ABCI points based on the total size of objects in buckets owned by your ABCI group are subtracted from your ABCI group's each day. There is no charge for data transfer or API calls. Users can check the total size by show_cs_usage. The calculation formula of ABCI points for using ABCI Object Storage is as follows.

```
ABCI point = the size of data stored in the storage of the previous day
× charge coefficient of ABCI Object Storage
```

| Page | Outline |
|:--|:--|
| [Accounts and Access Keys](./account.md) | This section explains accounts and access keys. |
| [Usage](./usage.md) | This section shows basic usage. |
| Encryption | This section explains encryption. |
| Access Control (1) | This section shows how to control accessibility by ACL. Data can be shared between groups. |
| Access Control (2) | This section explains access control which is applicable to buckets and user accounts. It is possible to set access control that cannot be done with ACL. Access crontrol settings for buckets can be done with a 'Object Storage Account for user', but 'Oloud Storage Account for manager' is necessary to set for access control settings for accounts. |
Loading

0 comments on commit cafbc0c

Please sign in to comment.