変換したコンテンツをリモートで保存する
機能
このオプションでは、最終のZIPファイルをクラウドベースのストレージにアップロードするためのリモートストレージオプションを指定することができます。
この機能は、利用するクラウドによってプロパティファイルを変えて制御します。アップロード先のクラウドプラットフォームは、1つのオプションで制御されます。
- storageprovider – 使用するリモートストレージクラスの完全修飾クラス名。
設定方法
まず、idr-microservice-storage からモジュールをビルドする必要があります。ビルドしたら、buildvu-microservice/lib ディレクトリに jar を置き、buildvu-microservice war ファイルをビルドします。
アプリケーション・サーバーを実行しているサーバー上に、以下のJavaプロパティファイルを作成してください（もしまだ作成していない場合）。{user.home}/.idr/buildvu-microservice/buildvu-microservice.properties
このファイルに、以下のキーと値のペアを追加する（キーがすでに存在する場合は更新する）。
- storageprovider – これは idr-microservice-storage の完全修飾クラス名でなければいけません。
例：storageprovider=com.idrsolutions.microservice.storage.AWSStorage
プラットフォームを選択したら、マイクロサービスがプラットフォームにファイルを送信できるように、追加の値を設定する必要があります。
以下に各プラットフォームの変数を示します。
AWS
Azure
GCP
Oracle
Digital Ocean
AWS
- storageprovider – must be set to com.idrsolutions.microservice.storage.AWSStorage
- storageprovider.aws.accesskey – Can be found at AWS -> IAM -> Access management -> Users
You may need to create an access key on the security credentials tab - storageprovider.aws.secretkey – Can be found at AWS -> IAM -> Access management -> Users
You may need to create an access key on the security credentials tab - storageprovider.aws.bucketname – Can be found at AWS, AWS -> S3
You will need the value from the Name column. - storageprovider.aws.region – Can be found at AWS, AWS -> S3
You will need the value from the AWS Region column for the bucket name. - storageprovider.aws.basepath – [Optional] The path inside the bucket where files will be stored.
Azure
- storageprovider – must be set to com.idrsolutions.microservice.storage.AzureStorage
- storageprovider.azure.accountname – can be found at Azure -> Storage Accounts, the value under the Name column.
- storageprovider.azure.accountkey – can be found at Azure -> Storage Account -> Security + networking -> Access keys.
- storageprovider.azure.containername – The name of the blob container inside the storage account.
- storageprovider.azure.basepath – [Optional] The path inside the bucket where files will be stored.
GCP
- storageprovider – must be set to com.idrsolutions.microservice.storage.GCPStorage
- storageprovider.gcp.credentialspath – You must generate a credentials file at GCP -> IAM -> Service Accounts
You will need a service account with write permissions to the bucket you will use. Enter the service account and go to the keys tab.
Create a new key with a type of JSON and save the file to disk. Then you need to add the file to the device running the microsystem. Use the files path as the value for this option.
If using Docker you will need to mount the file and set this value to the path on Docker. The mount can be done as below.--mount "source=/path/to/gcp/credentials.json,target=/root/.gcp/credentials.json,type=bind" - storageprovider.gcp.projectid – The name of the project containing the bucket. This can be found at GCP -> Project info.
- storageprovider.gcp.bucketname – The name of the bucket to store files in. This can be found at GCP -> Cloud Storage
- storageprovider.gcp.basepath – [Optional] The path inside the bucket where files will be stored.
Oracle
- storageprovider – must be set to com.idrsolutions.microservice.storage.OracleStorage
- storageprovider.oracle.ociconfigfilepath – Path to a config file generated at Oracle CLoud Platform -> Identity * Security -> Users If you don’t already have one, create a user with write permissions, open this user and got to the API Keys section. Click the option “Add API Key” and download both private and public keys that pop-up and save the private key in a directory called oci, then click add. In the Configuration File Preview, copy the preview content, update the private key path and save it into a file called config within the oci directory. If using Docker you will need to mount the oci directory and set this value to the path to the config file on Docker. The mount can be done as below.
--mount "source=/path/to/oci/,target=/root/.oci/,type=bind"Note, if using docker, the private key path in the config file should match the docker image path for the private key. - storageprovider.oracle.region – This can be found in the config file, or by getting the region name found in the Top Right corner of the Oracle Portal, then find the id on this look up table.
- storageprovider.oracle.profile – The profile within the config file to use. These can be found within the config file.
- storageprovider.oracle.bucketname – Can be found at Oracle Cloud Platform -> Storage -> Buckets The value in the name column is the bucket name.
- storageprovider.oracle.namespace – Can be found at Oracle Cloud Platform -> Storage -> Buckets Click on the bucket to use and see the namespace entry under the Bucket Information tab.
- storageprovider.oracle.basepath – [Optional] The path inside the bucket where files will be stored.
Digital Ocean
- storageprovider – must be set to com.idrsolutions.microservice.storage.DOStorage
- storageprovider.do.accesskey – Can be found at Digital Ocean -> API At the bottom of the page is “Space access keys”, you can generate/get a new key here.
- storageprovider.do.secretkey – Can be found at Digital Ocean -> API At the bottom of the page is “Space access keys”, you can generate/get a new secret here.
- storageprovider.do.bucketname – Can be found at Digital Ocean -> Spaces You will need the value in the Name column.
- storageprovider.do.region – Can be found at Digital Ocean -> Spaces The value can be found in the Spaces url between the second and third ‘.’
- storageprovider.do.basepath – [Optional] The path inside the bucket where files will be stored.
デフォルト値
値が指定されないか、無効な値が指定された場合、この機能は実行されず、zipファイルはサーバーのローカルストレージに保存されます。
Dockerでの使用方法
独自のプロパティファイルをDockerイメージに提供するには、プロパティファイルをイメージにマウントします。これには、docker runコマンドに以下を追加します。
--mount "source=/path/to/properties/directory/buildvu-microservice.properties,target=/root/.idr/buildvu-microservice/buildvu-microservice.properties,type=bind"