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

ABCI Singularity Endpoint (英語版) の追加 #207

Merged
merged 11 commits into from
Dec 10, 2020

Conversation

ahama
Copy link
Contributor

@ahama ahama commented Oct 29, 2020

No description provided.

@ahama ahama requested a review from s-yama October 29, 2020 17:27
ABCI Singularity Endpoint provides a singularity container service available within ABCI. This service consists of Remote Builder for remotely building container images using SingularityPRO and Container Library for storing and sharing the created container images. This service is available only within ABCI and cannot be accessed directly from outside of ABCI.

!!! warning
Container Library is an Experimental service. In particularly, it is not possible to upload container images larger than 64 MB.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:In particularly,
修正後:In particular,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正しました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。

When you have created an access token again, use the above command to register it. The old access token is overwritten by the new one.

!!! note
Access tokens currently expire in one month. When your access token has expired, create and register again.
Copy link
Collaborator

@s-yama s-yama Oct 30, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:create and register again.
修正後:create and register another access token again.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正しました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。


## Remote Builder

First, create a definition file to build the container image. The following example is definition of adding package to the container and executed command when the container run, based on Ubuntu container image from Docker HUB. For more information about definition files, see [Definition Files](https://repo.sylabs.io/c/0f6898986ad0b646b5ce6deba21781ac62cb7e0a86a5153bbb31732ee6593f43/guides/singularitypro35-user-guide/definition_files.html).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:adding package to the container and executed command when the container run,
修正後:installation of additional packages to the container and commands to be executed when the container is initiated,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The following example defines installation of additional packages to the container image and commands to be executed when the container image is run,
にしました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。

[username@es1 ~]$
```

As a test, the following example is to run the container image with `singularity run` command. The `lsb_release -d` command specified in the definition file is executed and the result is printed.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:As a test, the following example is to run the container
修正後:As confirmation, the following example shows how to run the container

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can run the container image with `singularity run` command as follows:

```
[username@es1 ~]$ qrsh -g grpname -l rt_C.small=1 -l h_rt=1:00:00
[username@g0001 ~]$ module load singularitypro/3.5
[username@g0001 ~]$ singularity run ubuntu.sif
Description:    Ubuntu 18.04.5 LTS
[username@g0001 ~]$ 
```

The `lsb_release -d` command specified in the definition file is executed and the result is printed.

としました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。

You can push your container images to Container Library and make those available to other ABCI users. Each user can store up to a total of 100 GiB.

!!! note
Container images pushed to the Container Library cannot be configured for access control. This means that anyone who uses ABCI will be able to access it, so make sure the container images are appropriate.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:Container images pushed to the Container Library cannot be configured for access control.
修正後:There is no access control function for the container images pushed to the Container Library.

修正前:anyone who uses ABCI will be able to access it
修正後:anyone who uses ABCI will be able to access them

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ご指摘どおり修正しました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。

!!! note
Container images pushed to the Container Library cannot be configured for access control. This means that anyone who uses ABCI will be able to access it, so make sure the container images are appropriate.

### Current Restriction
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:Current Restriction
修正後:Current Restrictions

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正しました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。

Container images pushed to the Container Library cannot be configured for access control. This means that anyone who uses ABCI will be able to access it, so make sure the container images are appropriate.

### Current Restriction
* Uploading a container image of 64 MiB or more is not allowed, but you can create a container image in a remote build.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:is not allowed,
修正後:is not possible,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正しました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。


| item | value |
| :-- | :-- |
| Enter your name | enter the ABCI account name. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:enter the ABCI account name.
修正後:Enter the ABCI account name.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正しました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。

| Enter your name | enter the ABCI account name. |
| Enter your email address | Although it says email address, enter the ABCI account name. |
| Enter optional comment | Enter comments you want to attach to this key pair. |
| Enter a passphrase | Determine your passphrase and enter it. This is necessary when signing a container image. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:This is necessary
修正後:It is going to be necessary

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正しました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。

| Enter a passphrase | Determine your passphrase and enter it. This is necessary when signing a container image. |
| Would you like to push it to the keystore? | Enter `Y` to upload the public key to Keystore. |

#### List Keys
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:List Keys
修正後:Listing Keys

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正しました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。


#### List Keys

To get information about the public keys including ones you created, use `singularity key list`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:To get information about the public keys including ones you created,
修正後:To retrieve key information which you created,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To retrieve information about the public keys in your local keyring, including ones you created, use singularity key list.
にしました。日本語も少し修正しました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。


#### Registering a Public Key in the Keystore

If you did not specify upload to the Keystore when you created the key pair, you can upload it later.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:If you did not specify upload to the Keystore
修正後:If you did not specify the option of uploading the public key to the Keystore

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you did not specify the option to upload a public key to Keystore,
にしました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。


#### Getting Public Keys Registered in the Keystore

Public keys registered in the Keystore can be downloaded and stored in your keyring. The following example downloads and saves the public key found by searching for username2. You can also search for a string that matches the comment attached to the key. The last parameter of `singularity key pull AAAA....` is a fingerprint to specify which public key to download.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前: which public key to download.
修正後: which public key to be downloaded.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

これは to download で良い気がします。やっぱりおかしいということでしたら何も考えずに修正します。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

了解しました。確認ありがとうございます。

### Upload Container Image

Before uploading to Container Library, sign the container image.
Check the key number with `singularity key list -s`, and sign the container with `singularity sign` command specified the key number by `-k` option.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:Check the key number with singularity key list -s, and sign the container with singularity sign command specified the key number by -k option.
修正後:Check the key number by singularity key list -s command, and sign the container by singularity sign command with -k option which specifies the the key number.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

まだ直していませんが、"by using" にすると思います。

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check the key number by using the singularity key list -s command, and sign the container by using the singularity sign command with the -k option to specify the key number.
にしました。

| container | Specify the container image name as any string. |
| tag | A string identifying the same container image. A string such as version, release date, revision number or `latest`. |

Here is an example of uploading a collection named `abci-lib`, container image named `ubuntu`, and tag `latest`:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:Here is an example of uploading a collection named abci-lib,
修正後:Here is an example of uploading a container image with collection named abci-lib,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is an example of uploading the container image ubuntu, specifying the collection name abci-lib and the tag name latest:
にしました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。


### Upload Container Image

Before uploading to Container Library, sign the container image.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:Before uploading to Container Library,
修正後:Before uploading a container image to Container Library,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

upload は intransitive でもあるみたいですが(そういう意味の指摘ではないのかもしれませんが)、いただいた内容の方が意味がわかりやすいので修正しました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。

[username@es1 ~]$
```

### Pulling container image
Copy link
Collaborator

@s-yama s-yama Oct 30, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:Pulling container image
修正後:Downloading Container Images

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正しました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。

[username@es1 ~]$ singularity key remove AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
```

### Upload Container Image
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:Upload Container Image
修正後:Uploading Container Images

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正しました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。

[username@es1 ~]$
```

If the signature cannot be verified, WARNING message similar to the following, but the download will continue.
Copy link
Collaborator

@s-yama s-yama Oct 30, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:WARNING message similar to the following,
修正後:you will see a warning message similar to the following,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正しました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。

!!! note
You can still run the container image if validation fails, but it is recommended that you use a verifiable container image.

### Searching Container Image
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正前:Searching Container Image
修正後:Searching Container Images

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正しました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。修正ありがとうございます。

@ahama
Copy link
Contributor Author

ahama commented Nov 13, 2020

@s-yama さん、ひととおり対応しましたので、ご確認お願いします。

@ogawa ogawa mentioned this pull request Dec 5, 2020
@ogawa ogawa changed the base branch from master to devel-202012 December 5, 2020 12:15
@s-yama s-yama merged commit 82e379e into devel-202012 Dec 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants