Steeltoe developer tool collection
Перейти к файлу
Chris Cheetham 9f2789bf64 stub new commands 2020-03-26 08:10:09 -04:00
build Adds more breadcrumbs to signing script 2019-10-23 15:42:53 -04:00
config use the StringTemplate template engine 2020-01-30 09:56:39 -05:00
docs Adds a section for Kubernetes 2019-11-18 13:29:53 -05:00
scripts Removes bash script variants 2019-01-29 14:17:18 -05:00
src stub new commands 2020-03-26 08:10:09 -04:00
test stub new commands 2020-03-26 08:10:09 -04:00
visual-studio-templates Update manifest.yml 2019-03-28 11:47:34 -05:00
.editorconfig Add support for EditorConfig 2019-11-15 07:37:58 -05:00
.gitattributes Initial checkin of tooling solution 2018-07-24 17:16:07 -04:00
.gitignore Signs packages prior to publishing 2019-10-10 14:38:50 -05:00
CONTRIBUTING.adoc Ports docs to Asciidoc 2018-10-26 09:13:27 -04:00
LICENSE URL Cleanup (#57) 2019-03-26 17:30:35 -05:00
README.adoc Fixes badge for AsciiDoctor 2019-10-01 10:02:47 -04:00
Tooling.sln [Closes #13] Adds a service life cycle state machine 2018-09-18 09:59:27 -04:00
Tooling.sln.DotSettings stub new commands 2020-03-26 08:10:09 -04:00
azure-pipelines.yml Update azure-pipelines.yml 2020-03-13 13:24:46 -04:00

README.adoc

:branch: dev
:uri-build: https://dev.azure.com/SteeltoeOSS/Steeltoe/_build?definitionId=11&_a=summary
:uri-build-status: https://dev.azure.com/SteeltoeOSS/Steeltoe/_apis/build/status/SteeltoeOSS.Tooling?branchName={branch}

= Steeltoe Tooling
:toc:
:toclevels: 2

image:{uri-build-status}["Build Status", link={uri-build}]

== About

Tools for Steeltoe Developers.

The goal of this project is to provide tools to assist Steeltoe Developers.
The current focus is an API and CLI to help with deploying Steeltoe Applications and dependent services to Cloud Foundry and Docker.

Subsequent goals include:

* a Visual Studio plugin leveraging the API
* plugins for other IDES, such as Visual Studio Code and JetBrains Riser
* Visual Studio/DotNET templates

== Quick Start

In this Quick Start, you'll install the Steeloe Tooling CLI and use it to deploy a sample SteeltoeOSS project to Docker.

.install Steeltoe Tooling CLI and check version
----
$ dotnet tool install --global --version 1.0.0-m1 Steeltoe.Cli
$ st --version
1.0.0-m1
----

.checkout Steeltoe Samples and navigate to the SimpleCloudFoundry project
----
$ git clone https://github.com/SteeltoeOSS/Samples.git
$ cd Samples/Configuration/src/AspDotNetCore/SimpleCloudFoundry
----

.add Steeltoe Tooling to project
----
$ st init
Initialized Steeltoe Developer Tools
----

.add application and config-server to deployment configuration
----
$ st add config-server myConfigServer
Added config-server service 'myConfigServer'

$ st add app SimpleCloudFoundry
Added app 'SimpleCloudFoundry'
----

.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
----
$ st deploy
Deploying service 'myConfigServer'
Deploying app 'SimpleCloudFoundry'
----

.check status, then navigate to application
----
$ st status
myConfigServer online
SimpleCloudFoundry online
----

Open http://localhost:8080/

.undeploy
----
$ st undeploy
Undeploying app 'SimpleCloudFoundry'
Undeploying service 'myConfigServer'
----

.deploy to Cloud Foundry
----
$ st target cloud-foundry
Cloud Foundry ... cf version 6.46.0+29d6257f1.2019-07-09
logged into Cloud Foundry ... yes
Target set to 'cloud-foundry'

$ st deploy
...
----

.deploy to Kubernetes
----
$ eval $(minikube docker-env)  # if using minikube's Docker

$ st target kubernetes
Kubernetes ... kubectl client version 1.15, server version 1.15
current context ... minikube
Target set to 'kubernetes'

$ st deploy
...
----

== Further Reading

See link:docs/[Steeltoe Tooling Documentation] for more user and developer information.