Reorgs docs
This commit is contained in:
Chris Cheetham
Родитель
c7cbf02037
Коммит
eb925a55f3
85
README.adoc
85
README.adoc
|
|
@ -1,39 +1,78 @@
|
|||
= Building Steeltoe Tooling
|
||||
= Steeltoe Tooling
|
||||
:toc:
|
||||
:toclevels: 2
|
||||
|
||||
_See link:docs/[documentation] for more user and developer information._
|
||||
|===
|
||||
| Platform | Build Status
|
||||
|
||||
== Testing
|
||||
| Windows | image:{uri-status-windows}?svg=true&branch={branch}["Windows Build Status", link={uri-build-windows}]
|
||||
| Linux/OS X | image:{uri-status-linuxosx}.svg?branch={branch}["Linux/OS X Build Status", link={uri-build-linuxosx}]
|
||||
|===
|
||||
|
||||
.Run unit test suite
|
||||
== About
|
||||
|
||||
Tools for Steeltoe Developers.
|
||||
|
||||
This projects provides a CLI to assist Steeltoe Developers with deploying Steeloe projects to Cloud Foundry and Docker.
|
||||
This project also provides an API that can be used to integrate Steeltoe Tooling with other tools such as IDEs.
|
||||
|
||||
== Quick Start
|
||||
|
||||
In this Quick Start, you'll install the Steeloe Tooling CLI and use it to deploy a WebApp project to a Docker host.
|
||||
|
||||
.install Steeltoe Tooling CLI
|
||||
----
|
||||
> scripts/unit-test
|
||||
|
||||
# Alternatively
|
||||
> dotnet test test/Steeltoe.Tooling.Test
|
||||
> dotnet tool install steeltoe.cli --global --add-source https://www.myget.org/F/steeltoedev/api/v3/index.json --version 1.0.0-dev-00146
|
||||
----
|
||||
|
||||
.Run CLI test suite
|
||||
.check version
|
||||
----
|
||||
> scripts/cli-test
|
||||
|
||||
# Alternatively
|
||||
> dotnet test test/Steeltoe.Cli.Test
|
||||
> st --version
|
||||
1.0.0-dev-00146
|
||||
----
|
||||
|
||||
== Install/Uninstall
|
||||
|
||||
.Install
|
||||
.create a WebApp project
|
||||
----
|
||||
> scripts/install
|
||||
|
||||
# Alternatively
|
||||
> dotnet pack
|
||||
> dotnet tool install -g --add-source src/Steeltoe.Cli/bin/Debug Steeltoe.Cli
|
||||
> dotnet new webapp -o myapp
|
||||
> cd myapp
|
||||
----
|
||||
|
||||
.Uninstall
|
||||
.add Steeltoe Tooling to project
|
||||
----
|
||||
> dotnet tool uninstall -g Steeltoe.Cli
|
||||
> st init
|
||||
Initialized Steeltoe Developer Tools
|
||||
----
|
||||
|
||||
.add WebApp application to deployment configuration
|
||||
----
|
||||
> st add app myapp
|
||||
Added app 'myapp'
|
||||
----
|
||||
|
||||
.target Docker for deployment
|
||||
----
|
||||
> st target docker
|
||||
Docker ... Docker version 18.09.1, build 4c52b90
|
||||
Docker host OS ... Docker for Mac
|
||||
Docker container OS ... linux
|
||||
Target set to 'docker
|
||||
----
|
||||
|
||||
.deploy project
|
||||
----
|
||||
> st deploy
|
||||
Deploying app 'myapp'
|
||||
----
|
||||
|
||||
.open WebApp
|
||||
Go to http://localhost:8080/
|
||||
|
||||
.undeploy project
|
||||
----
|
||||
> st undeploy
|
||||
Undeploying app 'myapp'
|
||||
----
|
||||
|
||||
== Further Reading
|
||||
|
||||
See link:docs/[Steeltoe Tooling Documentation] for more user and developer information.
|
||||
|
|
|
|||
15
builds.adoc
15
builds.adoc
|
|
@ -1,15 +0,0 @@
|
|||
:linkattrs:
|
||||
:branch: dev
|
||||
:uri-build-windows: https://ci.appveyor.com/project/steeltoe/tooling/branch/dev
|
||||
:uri-status-windows: https://ci.appveyor.com/api/projects/status/github/SteeltoeOSS/Tooling
|
||||
:uri-build-linuxosx: https://travis-ci.org/SteeltoeOSS/Tooling
|
||||
:uri-status-linuxosx: {uri-build-linuxosx}
|
||||
|
||||
= Steeltoe Tooling Builds: `{branch}` Branch
|
||||
|
||||
|===
|
||||
| Platform | Status
|
||||
|
||||
| Windows | image:{uri-status-windows}?svg=true&branch={branch}["Windows Build Status", link={uri-build-windows}]
|
||||
| Linux/OS X | image:{uri-status-linuxosx}.svg?branch={branch}["Linux/OS X Build Status", link={uri-build-linuxosx}]
|
||||
|===
|
||||
|
|
@ -2,12 +2,11 @@
|
|||
:toc:
|
||||
:toclevels: 2
|
||||
|
||||
== Users
|
||||
|
||||
link:scenario_01.adoc[Scenario 1]:: deploy a simple web app
|
||||
link:scenario_02.adoc[Scenario 2]:: deploy a service
|
||||
|
||||
== Developers
|
||||
|
||||
link:theory_of_operations.adoc[Theory of Operations]:: key Steeltoe Tooling implementation concepts
|
||||
link:build.adoc[Building]:: building, testing, and installing Steeltoe Tooling from source
|
||||
|
||||
== Users
|
||||
|
||||
link:users_guide.adoc[Users Guide]:: Users guide to using Steeltoe Tooling
|
||||
|
|
|
|||
|
|
@ -0,0 +1,23 @@
|
|||
= Building Steeltoe Tooling
|
||||
|
||||
.Build
|
||||
----
|
||||
> dotnet build
|
||||
----
|
||||
|
||||
.Run Unit and CLI Tests
|
||||
----
|
||||
> dotnet test test/Steeltoe.Tooling.Test
|
||||
> dotnet test test/Steeltoe.CLI.Test
|
||||
----
|
||||
|
||||
.Install
|
||||
----
|
||||
> dotnet pack
|
||||
> dotnet tool install -g --add-source src/Steeltoe.Cli/bin/Debug Steeltoe.Cli
|
||||
----
|
||||
|
||||
.Uninstall
|
||||
----
|
||||
> dotnet tool uninstall -g Steeltoe.Cli
|
||||
----
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
= Steeltoe Tooling: Scenario 1, a Simple App
|
||||
How to deploy an application using Steeltoe Tooling.
|
||||
|
||||
.Create a Simple Web App project
|
||||
----
|
||||
$ mkdir myapp
|
||||
$ cd myapp
|
||||
$ dotnet new webapp
|
||||
----
|
||||
|
||||
.Set up Steeltoe Tooling
|
||||
----
|
||||
$ st init
|
||||
$ st target docker # alternatively, st target cloudfoundry
|
||||
----
|
||||
|
||||
.Deploy the Simple Web App
|
||||
----
|
||||
$ st add app myapp
|
||||
$ st deploy
|
||||
Deploying app 'myapp'
|
||||
----
|
||||
|
||||
.Use the Simple Web App
|
||||
Go to https://localhost:5001/
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
= Steeltoe Tooling: Scenario 2, a Service
|
||||
How to deploy a service using Steeltoe Tooling.
|
||||
|
||||
.Create a project
|
||||
----
|
||||
$ mkdir myservice
|
||||
$ cd myservice
|
||||
----
|
||||
|
||||
.Set up Steeltoe Tooling
|
||||
----
|
||||
$ st init
|
||||
$ st target docker # alternatively, st target cloudfoundry
|
||||
----
|
||||
|
||||
.Deploy the service
|
||||
----
|
||||
$ st add config-server myconfig
|
||||
$ st deploy
|
||||
Deploying service 'myconfig'
|
||||
----
|
||||
|
||||
.Use the service
|
||||
----
|
||||
$ curl http://localhost:8888/foo/devlopment
|
||||
$ {"name":"foo","profiles":["devlopment"],"label":null,"version":"a611374438e75aa1b9808908c57833480944e1a8","state":null,"propertySources":[{"name":"https://github.com/spring-cloud-samples/config-repo/foo.properties","source":{"foo":"from foo props","democonfigclient.message":"hello spring io"}},{"name":"https://github.com/spring-cloud-samples/config-repo/application.yml (document #0)","source":{"info.description":"Spring Cloud Samples","info.url":"https://github.com/spring-cloud-samples","eureka.client.serviceUrl.defaultZone":"http://localhost:8761/eureka/","foo":"baz"}}]}
|
||||
----
|
||||
|
|
@ -0,0 +1,131 @@
|
|||
= Steeltoe Tooling Users Guide
|
||||
:toc:
|
||||
:toclevels: 3
|
||||
|
||||
== CLI
|
||||
|
||||
=== Installing
|
||||
|
||||
.install
|
||||
----
|
||||
> dotnet tool install steeltoe.cli --global --add-source https://www.myget.org/F/steeltoedev/api/v3/index.json --version 1.0.0-dev-00146
|
||||
----
|
||||
|
||||
.uninstall
|
||||
----
|
||||
> dotnet tool uninstall --global steeltoe.cli
|
||||
----
|
||||
|
||||
=== Deploying DotNet Projects
|
||||
|
||||
==== Simple WebApp
|
||||
|
||||
.create a WebApp project
|
||||
----
|
||||
> dotnet new webapp -o myapp
|
||||
> cd myapp
|
||||
----
|
||||
|
||||
.add Steeltoe Tooling to project
|
||||
----
|
||||
> st init
|
||||
Initialized Steeltoe Developer Tools
|
||||
----
|
||||
|
||||
.add WebApp application to deployment configuration
|
||||
----
|
||||
> st add app myapp
|
||||
Added app 'myapp'
|
||||
----
|
||||
|
||||
.target Docker for deployment
|
||||
----
|
||||
> st target docker
|
||||
Docker ... Docker version 18.09.1, build 4c52b90
|
||||
Docker host OS ... Docker for Mac
|
||||
Docker container OS ... linux
|
||||
Target set to 'docker
|
||||
----
|
||||
|
||||
.deploy project
|
||||
----
|
||||
> st deploy
|
||||
Deploying app 'myapp'
|
||||
----
|
||||
|
||||
.open WebApp
|
||||
Go to http://localhost:8080/
|
||||
|
||||
.undeploy project
|
||||
----
|
||||
> st undeploy
|
||||
Undeploying app 'myapp'
|
||||
----
|
||||
|
||||
==== Webapp with a Dependent Service
|
||||
|
||||
.checkout Steeltoe Samples and navigate to the SimpleCloudFoundry project
|
||||
----
|
||||
> git clone https://github.com/SteeltoeOSS/Samples
|
||||
> cd Samples/Configuration/src/AspDotNetCore/SimpleCloudFoundry
|
||||
----
|
||||
|
||||
.add Steeltoe Tooling to project
|
||||
----
|
||||
> st init
|
||||
Initialized Steeltoe Developer Tools
|
||||
----
|
||||
|
||||
.target CloudFoundry for deployment
|
||||
----
|
||||
> st target cloud-foundry
|
||||
Cloud Foundry ... cf version 6.42.0+0cba12168.2019-01-10
|
||||
logged into Cloud Foundry ... yes
|
||||
Target set to 'cloud-foundry'
|
||||
----
|
||||
|
||||
.add SimpleCloudFoundry webapp to deployment configuration
|
||||
----
|
||||
> st add app SimpleCloudFoundry
|
||||
Added app 'myapp'
|
||||
----
|
||||
|
||||
.add myConfigServer config-server to deployment configuration
|
||||
----
|
||||
> st add config-server myConfigServer
|
||||
Added config-server service 'myConfigServer'
|
||||
----
|
||||
|
||||
.deploy SimpleCloudFoundry project to CloudFoundry
|
||||
----
|
||||
> st deploy
|
||||
Deploying service 'myConfigServer'
|
||||
Waiting for service 'myConfigServer' to come online (1)
|
||||
Waiting for service 'myConfigServer' to come online (2)
|
||||
Waiting for service 'myConfigServer' to come online (3)
|
||||
Waiting for service 'myConfigServer' to come online (4)
|
||||
Waiting for service 'myConfigServer' to come online (5)
|
||||
...
|
||||
Waiting for service 'myConfigServer' to come online (35)
|
||||
Deploying app 'SimpleCloudFoundry'
|
||||
----
|
||||
|
||||
.check status, then navigate to application
|
||||
----
|
||||
> cf apps
|
||||
Getting apps in org pivot-ccheetham / space playground as ccheetham@pivotal.io...
|
||||
OK
|
||||
|
||||
name requested state instances memory disk urls
|
||||
SimpleCloudFoundry started 1/1 512M 1G simplecloudfoundry.apps.pcfone.io
|
||||
|
||||
# ^-------------------------------^
|
||||
# go to this url -------------------------------------------------/
|
||||
----
|
||||
|
||||
.undeploy SimpleCoundFoundry project
|
||||
----
|
||||
> st undeploy
|
||||
Undeploying app 'SimpleCloudFoundry'
|
||||
Undeploying service 'myConfigServer'
|
||||
----
|
||||
Загрузка…
Ссылка в новой задаче