Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lahsivjar/gcp-storage-wagon
Maven wagon provider for google cloud storage
https://github.com/lahsivjar/gcp-storage-wagon
gcp gcp-storage gcp-storage-wagon google-cloud-storage java-8 maven maven-extension maven-wagon wagon
Last synced: 14 days ago
JSON representation
Maven wagon provider for google cloud storage
- Host: GitHub
- URL: https://github.com/lahsivjar/gcp-storage-wagon
- Owner: lahsivjar
- License: apache-2.0
- Created: 2018-10-07T08:12:34.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-05T22:20:06.000Z (11 months ago)
- Last Synced: 2024-10-16T03:41:10.677Z (21 days ago)
- Topics: gcp, gcp-storage, gcp-storage-wagon, google-cloud-storage, java-8, maven, maven-extension, maven-wagon, wagon
- Language: Java
- Homepage: https://search.maven.org/artifact/com.lahsivjar/gcp-storage-wagon
- Size: 60.5 KB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Maven GCP Storage Wagon [](https://travis-ci.com/lahsivjar/gcp-storage-wagon) [](https://search.maven.org/artifact/com.lahsivjar/gcp-storage-wagon) [](https://coveralls.io/github/lahsivjar/gcp-storage-wagon?branch=master)
[Maven wagon](https://maven.apache.org/wagon/) provider for [Google Cloud Storage](https://cloud.google.com/storage/). It allows publishing and downloading of artifacts from Google Cloud Storage bucket.
## Usage
1\. To allow the plugin to access the bucket configure access to the GCP by following instructions [here](https://cloud.google.com/docs/authentication/getting-started). The easiest way to do so is by using [IAM Service Accounts](https://cloud.google.com/iam/docs/understanding-service-accounts) and configuring environment variable `GOOGLE_APPLICATION_CREDENTIALS`.
2\. Configure the target project to use maven wagon for handling transport via `pom.xml`:
```xml
com.lahsivjar
gcp-storage-wagon
${gcp.storage.wagon.version}
```
Maven loads parent pom before loading any wagon thus if the parent pom also relies on wagon plugin we have to use `.mvn/extensions.xml` file released in [Maven 3.3.1](https://maven.apache.org/docs/3.3.1/release-notes.html) in the root of the target project. Example:
```xml
com.lahsivjar
gcp-storage-wagon
${gcp.storage.wagon.version}
```
3\. Setup distribution management in the target project to deploy artifacts to:
```xml
gcp-bucket-snapshot
gs://${gcp.project-id}#${gcp.maven.bucket}/snapshot
gcp-bucket-release
gs://${gcp.project-id}#${gcp.maven.bucket}/release
```
__NOTE__: Check [Project Id Resolution](#gcp-project-id-resolution) section to find all supported ways of resolving GCP project id.
4\. To use the deployed modules in another project add extension as described in step `2` to the target project and specify a repository with the wagon configured:
```xml
gcp-bucket-snapshot
gs://${gcp.project-id}#${gcp.maven.bucket}/snapshot
gcp-bucket-release
gs://${gcp.project-id}#${gcp.maven.bucket}/release
```
__NOTE__: Check [Project Id Resolution](#gcp-project-id-resolution) section to find all supported ways of resolving GCP project id.
## GCP Project Id resolution
Project id of GCP can be resolved in the following two ways(in decreasing priority):
1. By specifying it as part of the repository url. For example: `gs://${gcp.project-id}#${gcp.maven.bucket}/`
2. By setting environment variable `WAGON_GCP_PROJECT_ID`. In this case the url must be of the form `gs://${gcp.maven.bucket}/...`
__NOTE__: It is priority based so if project id can be resolved via a higher priority resolver then the lower priority won't be considered
## Environment variable interpolation
Hash based project id resolution scheme supports environment variable interpolation by specifying the repository url as `gs://${env.GCP_PROJECT_ID}#${env.BUCKET_NAME}` with `GCP_PROJECT_ID` and `BUCKET_NAME` exported as environment variables.
## Issues
Report any issues or bugs to https://github.com/lahsivjar/gcp-storage-wagon/issues
## Changelog
### 3.0
* Update module to support Java 11
### 2.1
* (Bugfix #19) Handle small files in single blob request
### 2.0
* Environment variable interpolation for hash separated project id resolution
### 1.0
* Add support for environment variable based project id resolution
### 0.1
* Add basic wagon for GCP storage
* Support resolving project id via the repository url
## License
The project is licensed under Apache-2.0 - see the [LICENSE](LICENSE) file for details.