Rename all the asciidoc documents to .adoc and re-create the README
This commit is contained in:
parent
34dfa0df45
commit
7b8c772047
|
@ -1,30 +1,7 @@
|
|||
= #DeployDB
|
||||
|
||||
image::https://badges.gitter.im/Join%20Chat.svg[link="https://gitter.im/lookout/deploydb"]
|
||||
image:https://travis-ci.org/lookout/deploydb.svg?branch=master["Build Status", link="https://travis-ci.org/lookout/deploydb"]
|
||||
= DeployDB
|
||||
|
||||
**Who, what, where and when.**
|
||||
|
||||
---
|
||||
|
||||
== Important Links
|
||||
|
||||
* link:https://github.com/lookout/deploydb[Source code]
|
||||
* link:https://github.com/lookout/deploydb/issues[Issue Tracker]
|
||||
* link:https://bintray.com/lookout/systems/DeployDB/_latestVersion[Latest released version]
|
||||
|
||||
=== Internals/Hacking
|
||||
|
||||
* <<hacking.ad#,Hacking DeployDB>>
|
||||
* link:restapi/index.html[REST API documentation]
|
||||
* link:groovydoc/index.html[Groovydocs]
|
||||
* <<internals.ad#,Data model/Internals>>
|
||||
* <<config.ad#,Configuration>>
|
||||
* <<auth.ad#,Authentication>>
|
||||
* <<workflow.ad#,Workflow>>
|
||||
* <<webui.ad#,Web UI Design/concepts>>
|
||||
|
||||
|
||||
== The Problem
|
||||
|
||||
As a service-oriented infrastructure grows, testing and managing/driving
|
||||
|
@ -34,6 +11,15 @@ Tracking versions of application and configuration management code through a
|
|||
consistent pipeline of tiered environments where verification of those changes
|
||||
can occur is difficult.
|
||||
|
||||
=== Internals/Hacking
|
||||
|
||||
* <<doc/hacking.adoc#,Hacking DeployDB>>
|
||||
* <<doc/internals.adoc#,Data model/Internals>>
|
||||
* <<doc/config.adoc#,Configuration>>
|
||||
* <<doc/auth.adoc#,Authentication>>
|
||||
* <<doc/workflow.adoc#,Workflow>>
|
||||
* <<doc/webui.adoc#,Web UI Design/concepts>>
|
||||
|
||||
== The Solution
|
||||
|
||||
DeployDB is a tool to provide a single source of truth for artifact-based
|
|
@ -1,72 +0,0 @@
|
|||
== Running the deploydb from bintray
|
||||
|
||||
* Download the deploydb-*tar from bintray
|
||||
* Uncompress the tar file
|
||||
|
||||
* Create deploydb model configuration. Check the following directory link for configuration template
|
||||
files for the deploydb models.
|
||||
Make sure all the model configuration files are *_stored in a single_* directory
|
||||
----
|
||||
https://github.com/lookout/deploydb/tree/master/example/modelConfig
|
||||
----
|
||||
|
||||
* Create deploydb application configuration. Check the following link for template of this
|
||||
configuration
|
||||
----
|
||||
https://github.com/lookout/deploydb/blob/master/example/deploydb.launch.yml
|
||||
----
|
||||
|
||||
* Update the model configuration directory parameter in the application configuration
|
||||
----
|
||||
configDirectory: <model-directory-name/path>
|
||||
----
|
||||
|
||||
* Setup the database before starting the deploydb. Use the created application configuration from the
|
||||
above section
|
||||
----
|
||||
./bin/deploydb db migrate <application-configuration>.yml
|
||||
----
|
||||
|
||||
* Start the deploydb using following command
|
||||
----
|
||||
./bin/deploydb server <application-configuration>.yml
|
||||
----
|
||||
|
||||
=== Running the deploydb from github repo
|
||||
|
||||
To run the application on localhost run the following commands.
|
||||
|
||||
* Package the deploydb from source using following command
|
||||
|
||||
----
|
||||
gradlew shadowJar
|
||||
----
|
||||
|
||||
* Setup the database using following command. Default database is H2 and db file is stored in
|
||||
current directory as deploydb.example.db.
|
||||
|
||||
----
|
||||
java -jar build/libs/deploydb-*-all.jar db migrate example/deploydb.launch.yml
|
||||
----
|
||||
|
||||
* Run the deploydb using following command. The last argument of the command below is the application
|
||||
configuration file of the deploydb. Please check and update this file as required. An example model
|
||||
configuration for webhooks, service and environment etc is present in example/modelConfig directory.
|
||||
Change the content of these model configuration files to the required values.
|
||||
|
||||
----
|
||||
java -jar build/libs/deploydb-*-all.jar server example/deploydb.launch.yml
|
||||
----
|
||||
|
||||
* To create artifact (That triggers deployment create)
|
||||
|
||||
----
|
||||
curl -X POST -H "Content-Type: application/json" http://localhost:8080/api/artifacts -d '{"group" : "basic.group.1", "name": "bg1", "version" : "1.2.3.4", "sourceUrl" : "http://example.com/cucumber.jar"}'
|
||||
----
|
||||
|
||||
* To get all deployments
|
||||
|
||||
----
|
||||
curl -X GET http://localhost:8080/api/deployments
|
||||
----
|
||||
|
Loading…
Reference in New Issue