initial checkin
This commit is contained in:
9
beedk-ate-docker-tile/.gitignore
vendored
Normal file
9
beedk-ate-docker-tile/.gitignore
vendored
Normal file
@@ -0,0 +1,9 @@
|
||||
# Eclipse
|
||||
.project
|
||||
.classpath
|
||||
.settings
|
||||
|
||||
# Maven
|
||||
pom.xml.versionsBackup
|
||||
target
|
||||
|
||||
71
beedk-ate-docker-tile/README.md
Normal file
71
beedk-ate-docker-tile/README.md
Normal file
@@ -0,0 +1,71 @@
|
||||
# BeeDK Docker Alfresco Transform Engine Maven Tile
|
||||
|
||||
This is a component within the proposed [BeeDK](/inteligr8/ootbee-beedk). It is considered to be part of the **Public API** of the BeeDK.
|
||||
|
||||
## Purpose
|
||||
|
||||
This project creates a [Maven Tile](https://github.com/repaint-io/maven-tiles) that provides the basis for any ATE that is delivered as a Docker Image.
|
||||
|
||||
## Usage
|
||||
|
||||
To use this plugin, just reference it with the Maven Tiles plugin as shown in the following snippet. Do not forget the `extensions` element in the *plugin* configuration.
|
||||
|
||||
```xml
|
||||
<project ...>
|
||||
...
|
||||
<build>
|
||||
...
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>io.repaint.maven</groupId>
|
||||
<artifactId>tiles-maven-plugin</artifactId>
|
||||
<version>[2.0,3.0)</version>
|
||||
<extensions>true</extensions>
|
||||
<configuration>
|
||||
<tiles>
|
||||
...
|
||||
<!-- Documentation: https://bitbucket.org/inteligr8/ootbee-beedk/src/stable/beedk-ate-docker-tile -->
|
||||
<tile>com.inteligr8.ootbee:beedk-ate-docker-tile:[1.0.0,2.0.0)</tile>
|
||||
<!-- See Below
|
||||
<tile>com.inteligr8.ootbee:beedk-ate-springboot-tile:[1.0.0,2.0.0)</tile>
|
||||
-->
|
||||
</tiles>
|
||||
</configuration>
|
||||
</plugin>
|
||||
...
|
||||
</plugins>
|
||||
...
|
||||
</build>
|
||||
...
|
||||
</project>
|
||||
```
|
||||
|
||||
This tile is nearly always used in conjunction with `beedk-ate-springboot-tile` Maven Tile. If the `Dockerfile` intends to package the Spring Boot application, this Maven Tile must be declared **BEFORE** that Maven Tile.
|
||||
|
||||
## Configuration
|
||||
|
||||
In your Maven project, set the following properties to define the behavior of this Maven Tile. Unless otherwise stated, they can only be overridden in the project POM or other Maven Tiles loaded earlier than this Maven Tile.
|
||||
|
||||
### Public API
|
||||
|
||||
The following properties are intended to be exposed by inheriting Public API Maven Tiles.
|
||||
|
||||
| Maven Property | Required | Default | Description |
|
||||
| ------------------------------ |:--------:| ------------------ | ----------- |
|
||||
| `docker.source.directory` | | `src/main/docker` | The source directory of the `Dockerfile` and related resources.<br/>*Inherited from [`beedk-springboot-docker-base-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-springboot-docker-base-tile)* |
|
||||
| `beedk.deploy.dockerImageOnly` | | true | Set to `true` to skip the Maven `deploy` of the Spring Boot application; `false` to deploy it to the configured Maven Repository. Regardless, the Docker Image will be deployed to the configured Docker Registry.<br/>*Inherited from [`beedk-springboot-docker-base-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-springboot-docker-base-tile)* |
|
||||
| `docker.image.registry` | **Yes** | | The Docker Registry where to push the built Docker Image. If none is specified, Docker pushes to the [Docker Hub](https://hub.docker.com).<br/>*Inherited from [`beedk-springboot-docker-base-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-springboot-docker-base-tile)* |
|
||||
| `docker.image.name` | **Yes** | | The Docker Image name. You typically want to pattern it as `prefix/${project.artifactId}`.<br/>*Inherited from [`beedk-springboot-docker-base-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-springboot-docker-base-tile)* |
|
||||
| `docker.image.tag` | | *Project Version* | The Docker Image tag or label. This will default to the Maven project version.<br/>*Inherited from [`beedk-springboot-docker-base-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-springboot-docker-base-tile)* |
|
||||
|
||||
## Results
|
||||
|
||||
A Docker image will be built using your local Docker installation during the `package` phase. It will be tagged both with and without the configured Docker Registry. During the `deploy` phase, the Docker image will be pushed to the configured Docker Registry.
|
||||
|
||||
## Initialization
|
||||
|
||||
This tile comes with the ability to initialize your project with a sample file of a Docker ATE. You can do this by executing any Maven build with the `scaffold` property.
|
||||
|
||||
```sh
|
||||
mvn -Dscaffold generate-sources
|
||||
```
|
||||
47
beedk-ate-docker-tile/pom.xml
Normal file
47
beedk-ate-docker-tile/pom.xml
Normal file
@@ -0,0 +1,47 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
|
||||
<groupId>com.inteligr8.ootbee</groupId>
|
||||
<artifactId>beedk-ate-docker-tile</artifactId>
|
||||
<version>1.0-SNAPSHOT</version>
|
||||
<packaging>tile</packaging>
|
||||
|
||||
<name>Order of the Bee Development Kit: ATE Docker Enablement</name>
|
||||
<scm>
|
||||
<url>https://bitbucket.org/inteligr8/ootbee-beedk</url>
|
||||
</scm>
|
||||
<organization>
|
||||
<name>Order of the Bee</name>
|
||||
<url>https://orderofthebee.net</url>
|
||||
</organization>
|
||||
<developers>
|
||||
<developer>
|
||||
<name>Brian Long</name>
|
||||
<email>brian@inteligr8.com</email>
|
||||
<organization>Inteligr8</organization>
|
||||
<organizationUrl>https://www.inteligr8.com</organizationUrl>
|
||||
<url>https://twitter.com/brianmlong</url>
|
||||
</developer>
|
||||
</developers>
|
||||
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>io.repaint.maven</groupId>
|
||||
<artifactId>tiles-maven-plugin</artifactId>
|
||||
<version>2.20</version>
|
||||
<extensions>true</extensions>
|
||||
<configuration>
|
||||
<tiles>
|
||||
<tile>com.inteligr8:maven-public-deploy-tile:[1.0.0,2.0.0)</tile>
|
||||
</tiles>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
</project>
|
||||
59
beedk-ate-docker-tile/tile.xml
Normal file
59
beedk-ate-docker-tile/tile.xml
Normal file
@@ -0,0 +1,59 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns="http://tiles.bluetrainsoftware.com/maven/tiles/1.1.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://tiles.bluetrainsoftware.com/maven/tiles/1.1.0 https://bitbucket.org/inteligr8/maven-tiles/raw/xsd/src/main/resources/maven-tiles.xsd">
|
||||
|
||||
<profiles>
|
||||
<profile>
|
||||
<id>scaffold-ate-docker</id>
|
||||
<activation>
|
||||
<property>
|
||||
<name>scaffold</name>
|
||||
</property>
|
||||
</activation>
|
||||
<build>
|
||||
<plugins>
|
||||
<!-- This plugin downloads the required configurations for all modules -->
|
||||
<plugin>
|
||||
<groupId>com.googlecode.maven-download-plugin</groupId>
|
||||
<artifactId>download-maven-plugin</artifactId>
|
||||
<version>1.6.1</version>
|
||||
<executions>
|
||||
<!-- TODO eventually replace these with the archetype versions -->
|
||||
<execution>
|
||||
<id>download-dockerfile</id>
|
||||
<phase>generate-sources</phase>
|
||||
<goals>
|
||||
<goal>wget</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<url>https://raw.githubusercontent.com/Alfresco/alfresco-transform-core/master/alfresco-transform-misc/alfresco-transform-misc-boot/Dockerfile</url>
|
||||
<outputDirectory>${basedir}/src/main/docker</outputDirectory>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</profile>
|
||||
<profile>
|
||||
<id>default-props</id>
|
||||
<activation>
|
||||
<property>
|
||||
<name>!some-prop-that-never-exists</name>
|
||||
</property>
|
||||
</activation>
|
||||
<properties>
|
||||
<!-- configuring beedk-ate-it-tile, if applicable -->
|
||||
<ate.docker.image.name>${docker.image.name}</ate.docker.image.name>
|
||||
<ate.docker.image.tag>${docker.image.tag}</ate.docker.image.tag>
|
||||
</properties>
|
||||
</profile>
|
||||
</profiles>
|
||||
|
||||
<tiles>
|
||||
<!-- Documentation: https://bitbucket.org/inteligr8/ootbee-beedk/src/stable/beedk-springboot-docker-base-tile -->
|
||||
<tile>com.inteligr8.ootbee:beedk-springboot-docker-base-tile:1.0-SNAPSHOT</tile>
|
||||
</tiles>
|
||||
|
||||
</project>
|
||||
Reference in New Issue
Block a user