Skip to content

Commit

Permalink
Initial documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@spyrkob
spyrkob committed Sep 16, 2022
1 parent 99a8f66 commit cfeaa3e
Show file tree
Hide file tree
Showing 7 changed files with 113 additions and 55 deletions.
9 changes: 9 additions & 0 deletions dist/docs/guide/concepts/channels.adoc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
### Channels

Wildfly Channels are a way to provide a curated list of compatible, up-to-date components. A channel consists of a YAML definition file and underlying Maven repository(-ies).

There are two types of Wildfly Channels supported by Prospero - open channels and manifest channels. Open channels allow access to the latest artifacts in the underlying repository, while manifest channels define a list of allowed list of components.

#### Generating channels

[TBC]
7 changes: 7 additions & 0 deletions dist/docs/guide/concepts/galleon.adoc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
### Feature Packs

While Wildfly Channels provide information on what versions of components should be installed, Galleon Feature-packs provide structure for installed servers.

Feature-pack represents a released unit of software (project, product, component, etc) that can be installed or uninstalled. Feature-packs are ZIP archives usually available in Maven repositories.

The Feature Packs definition is available at https://docs.wildfly.org/galleon/#_feature_packs.
7 changes: 7 additions & 0 deletions dist/docs/guide/concepts/index.adoc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Concepts

Prospero builds on Galleon project to provision and assemble requested server, and on Wildfly Channels to find and resolve the latest supported component versions.

include::channels.adoc[]

include::galleon.adoc[]
6 changes: 6 additions & 0 deletions dist/docs/guide/index.adoc
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
= Prospero documentation

include::overview/index.adoc[]

include::concepts/index.adoc[]

include::usage/index.adoc[]

include::customization/index.adoc[]
17 changes: 17 additions & 0 deletions dist/docs/guide/overview/index.adoc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Overview

Prospero is a tool designed to install and update Wildfly servers.

The tool supports:

* Provisioning Wildfly servers
* Updating Wildfly servers
* Installation history and rollback
* Management of repositories and channels installation is subscribed to
* Promoting artifacts between channels

Prospero includes a CLI client and a public API.

Releases of the command line tool will be available at [TBC].

To use the tool, download and unzip the release zip, and add the bin directory to your system path. Use `prospero.sh` or `prospero.bat` to launch the tool.
22 changes: 22 additions & 0 deletions dist/docs/guide/usage/index.adoc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## Usage

### Installation

To provision a Wildfly server, Prospero requires a few pieces of information:

* channel definition
* location of channel's Maven repositories
* feature-pack name
[source, bash]
----
$ ./prospero.sh install \
--dir=wfly-27 \ # <1>
--fpl=org.wildfly:wildfly-ee-galleon-pack \ #<2>
--channel=/path/to/wildfly-27.0.0.Final-channel.yaml \ #<3>
--remote-repositories=https://repo1.maven.org/maven2/,https://repository.jboss.org/nexus/content/groups/public/ #<4>
----
<1> output directory
<2> Maven `<groupId>:<artifactId>` coordinates of the feature pack to be installed
<3> Path to the channel file
<4> List of Maven repositories containing components listed in the channel file.
100 changes: 45 additions & 55 deletions dist/docs/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,59 +19,49 @@
<ec2-pub-ip>1.2.3.4</ec2-pub-ip>
</properties>

<profiles>
<profile>
<id>release</id>
<activation>
<property>
<name>release</name>
</property>
</activation>
<build>
<plugins>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<executions>
<execution>
<phase>process-resources</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<sourceDirectory>${basedir}/guide</sourceDirectory>
<sourceDocumentName>index.adoc</sourceDocumentName>
<imagesDir>images</imagesDir>
<backend>html</backend>
<doctype>book</doctype>
<attributes>
<version>${project.version}</version>
<ec2-pub-ip-dash>${ec2-pub-ip-dash}</ec2-pub-ip-dash>
<ec2-pub-ip>${ec2-pub-ip}</ec2-pub-ip>
</attributes>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
<configuration>
<descriptors>
<descriptor>scripts/assembly-docs.xml</descriptor>
</descriptors>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
</profiles>
<build>
<plugins>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<executions>
<execution>
<phase>process-resources</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<sourceDirectory>${basedir}/guide</sourceDirectory>
<sourceDocumentName>index.adoc</sourceDocumentName>
<imagesDir>images</imagesDir>
<backend>html</backend>
<doctype>book</doctype>
<attributes>
<version>${project.version}</version>
<ec2-pub-ip-dash>${ec2-pub-ip-dash}</ec2-pub-ip-dash>
<ec2-pub-ip>${ec2-pub-ip}</ec2-pub-ip>
</attributes>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
<configuration>
<descriptors>
<descriptor>scripts/assembly-docs.xml</descriptor>
</descriptors>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>

0 comments on commit cfeaa3e

Please sign in to comment.