Resolution for Local Minio/Cloud-Hosted S3 Configuration in IDE Services On-Prem Installation

Problem

The user is unable to configure the server configuration file for IDE Services On-Prem installation to bypass the requirement for an S3-compatible object store such as Minio. The server fails to start due to an UnknownHostException or Unable to find storage bucket error caused by an invalid local Minio URL/AWS S3 bucket.

Cause

1. The IDE Services On-Prem server requires an Object Storage to function correctly.
2. The Minio URL provided in the application.yml file (https://minio) is invalid and does not resolve to a valid endpoint, leading to an UnknownHostException error.
3. The S3 bucket is missing/wrong credentials/lack of permission, leading to an Unable to find storage bucket error.

Resolution

1. An object storage is mandatory for local installation of IDE Services. This can be Minio (installed locally or on a virtual machine) or a cloud-hosted solution such as AWS S3.

2. Refer to the IDE Services object storage documentation to understand what is stored in the object storage and how it is utilized.

3. If using a local Minio instance, ensure to run it through Docker or an appropriate VM setup. Detailed steps are available on the Minio Docker Hub page.

   • Update the server configuration file: application.yml or values.yaml with accurate and valid Minio configuration. For example:

     storage:
         type: s3
     minio:
         url: "http://minio"  # Replace with the public/current address of Minio
         bucket: "toolbox"
         access-key: "minioadmin"   # Default access key for Minio
         secret-key: "minioadmin"   # Default secret key for Minio
         s3-region: "us-east-1"     # Specify the region # optional
     

4. If using cloud-hosted AWS S3:

   • Ensure the S3 bucket exists and assign it both read and write permissions for objects.

   • If using AWS's local machine authentication, access and secret keys might not be mandatory. Configure the following in the application.yml:

     storage:
       type: S3
     minio:
       url: "https://s3.${tbe.minio.s3-region}.amazonaws.com"
       bucket: <bucket-name>
       access-key: ""
       secret-key: ""
       s3-region: <region>
       path-style-access: true #optional
     

   • Verify S3 IAM policies to ensure appropriate access.

5. Test connectivity to the Minio server or the S3-compatible object store to ensure that the provided URL is accessible from the server hosting IDE Services.

After resolving the Minio/S3 configuration, retry starting the IDE Services server.