Skip to content
This repository has been archived by the owner on Jul 28, 2023. It is now read-only.

Commit

Permalink
Merge pull request #168 from tseelbach/readmeupdate
Browse files Browse the repository at this point in the history
renamed collection to stack
  • Loading branch information
davco01a authored Feb 7, 2020
2 parents d2419c0 + 9c14def commit c7e2099
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 41 deletions.
56 changes: 28 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ path: /cmd/docs.go
# kabanero CLI
## kabanero

This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero collections that are used by developers to create governed applications for their business.
This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero stacks that are used by developers to create governed applications for their business.

### Synopsis

**kabanero** is a command line interface for managing the collections in a Kabanero
**kabanero** is a command line interface for managing the stacks in a Kabanero
environment, as well as to on-board the people that will use
the environment to build applications.

Expand All @@ -27,15 +27,15 @@ Complete documentation is available at https://kabanero.io

### SEE ALSO

* [kabanero deactivate](#kabanero-deactivate) - Remove the specified collection from the list of available application types, without deleting it from the Kabanero instance.
* [kabanero list](#kabanero-list) - List all the collections in the kabanero instance, and their status
* [kabanero deactivate](#kabanero-deactivate) - Remove the specified stack from the list of available application types, without deleting it from the Kabanero instance.
* [kabanero list](#kabanero-list) - List all the stacks in the kabanero instance, and their status
* [kabanero login](#kabanero-login) - Will authenticate you to a Kabanero instance
* [kabanero logout](#kabanero-logout) - Disconnect from Kabanero instance
* [kabanero onboard](#kabanero-onboard) - Command to onboard a developer to the Kabanero infrastructure
* [kabanero sync](#kabanero-sync) - sync the collections list
* [kabanero sync](#kabanero-sync) - sync the stack list
* [kabanero version](#kabanero-version) - Show Kabanero CLI version

###### Auto generated by spf13/cobra on 11-Dec-2019
###### Auto generated by spf13/cobra on 7-Feb-2020
## kabanero login

Will authenticate you to a Kabanero instance
Expand Down Expand Up @@ -79,9 +79,9 @@ kabanero login kabanero-url -u Github userid /n PASSWORDPROMPT:GitHub Password|P

### SEE ALSO

* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero collections that are used by developers to create governed applications for their business.
* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero stacks that are used by developers to create governed applications for their business.

###### Auto generated by spf13/cobra on 11-Dec-2019
###### Auto generated by spf13/cobra on 7-Feb-2020
## kabanero logout

Disconnect from Kabanero instance
Expand Down Expand Up @@ -110,17 +110,17 @@ kabanero logout [flags]

### SEE ALSO

* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero collections that are used by developers to create governed applications for their business.
* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero stacks that are used by developers to create governed applications for their business.

###### Auto generated by spf13/cobra on 11-Dec-2019
###### Auto generated by spf13/cobra on 7-Feb-2020
## kabanero list

List all the collections in the kabanero instance, and their status
List all the stacks in the kabanero instance, and their status

### Synopsis

List all the collections in the kabanero instance, and their status.
Modifications to the curated collection may be slow to replicate in git hub and therefore may not be reflected immediately in KABANERO LIST or SYNC display output
List all the stacks in the kabanero instance, and their status.
Modifications to the curated stack may be slow to replicate in git hub and therefore may not be reflected immediately in KABANERO LIST or SYNC display output

```
kabanero list [flags]
Expand All @@ -140,18 +140,18 @@ kabanero list [flags]

### SEE ALSO

* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero collections that are used by developers to create governed applications for their business.
* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero stacks that are used by developers to create governed applications for their business.

###### Auto generated by spf13/cobra on 11-Dec-2019
###### Auto generated by spf13/cobra on 7-Feb-2020
## kabanero sync

sync the collections list
sync the stack list

### Synopsis

Run the kabanero sync command to synchronize the list of kabanero instance collections with the curated collection from github. This will activate/deactivate as well as update versions of the kabanero collections to reflect the state of the curated collection.
Run the kabanero sync command to synchronize the list of kabanero instance stacks with the curated stacks from github. This will activate/deactivate as well as update versions of the kabanero stacks to reflect the state of the curated stacks.
See also kabanero deactivate.
Modifications to the curated collection may be slow to replicate in git hub and therefore may not be reflected immediately in KABANERO LIST or SYNC display output
Modifications to the curated stacks may be slow to replicate in git hub and therefore may not be reflected immediately in KABANERO LIST or SYNC display output


```
Expand All @@ -172,9 +172,9 @@ kabanero sync [flags]

### SEE ALSO

* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero collections that are used by developers to create governed applications for their business.
* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero stacks that are used by developers to create governed applications for their business.

###### Auto generated by spf13/cobra on 11-Dec-2019
###### Auto generated by spf13/cobra on 7-Feb-2020
## kabanero onboard

Command to onboard a developer to the Kabanero infrastructure
Expand Down Expand Up @@ -203,22 +203,22 @@ kabanero onboard github-id [flags]

### SEE ALSO

* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero collections that are used by developers to create governed applications for their business.
* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero stacks that are used by developers to create governed applications for their business.

###### Auto generated by spf13/cobra on 11-Dec-2019
###### Auto generated by spf13/cobra on 7-Feb-2020
## kabanero deactivate

Remove the specified collection from the list of available application types, without deleting it from the Kabanero instance.
Remove the specified stack from the list of available application types, without deleting it from the Kabanero instance.

### Synopsis


Run the deactivate command to remove the specified collection from the list of available application types, without deleting it from the Kabanero instance.
Run the deactivate command to remove the specified stack from the list of available application types, without deleting it from the Kabanero instance.

This command is useful in a case where you have cloned a collection and customized it for your business needs. Deactivation keeps the base collection in the app hub. The base collection continues to be updated and the updates percolate up to your cloned collection. To restore a deactivated collection, run the kabanero refresh command.
This command is useful in a case where you have cloned a stack and customized it for your business needs. Deactivation keeps the base stack in the app hub. The base stack continues to be updated and the updates percolate up to your cloned stack. To restore a deactivated stack, run the kabanero refresh command.

```
kabanero deactivate collection-name [flags]
kabanero deactivate stack-name version [flags]
```

### Options
Expand All @@ -235,6 +235,6 @@ kabanero deactivate collection-name [flags]

### SEE ALSO

* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero collections that are used by developers to create governed applications for their business.
* [kabanero](#kabanero) - This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero stacks that are used by developers to create governed applications for their business.

###### Auto generated by spf13/cobra on 11-Dec-2019
###### Auto generated by spf13/cobra on 7-Feb-2020
8 changes: 4 additions & 4 deletions cmd/activate.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ import (

// activateCmd represents the activate command
var activateCmd = &cobra.Command{
Use: "activate collection-name",
Use: "activate stack-name",
Hidden: true,
Short: "Activate a collection for use by the development team",
Short: "Activate a stack for use by the development team",
Long: `
A collection can be available to a development team
A stack can be available to a development team
to use for building applications or not. Activate
will cause the collection to be shown to
will cause the stack to be shown to
the develoopment team when they list the types of
application they can build.`,
Run: func(cmd *cobra.Command, args []string) {
Expand Down
10 changes: 5 additions & 5 deletions cmd/deactivate.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,16 @@ import (
var deactivateCmd = &cobra.Command{
Args: cobra.MinimumNArgs(1),
Use: "deactivate stack-name version",
Short: "Remove the specified collection from the list of available application types, without deleting it from the Kabanero instance.",
Short: "Remove the specified stack from the list of available application types, without deleting it from the Kabanero instance.",
Long: `
Run the deactivate command to remove the specified collection from the list of available application types, without deleting it from the Kabanero instance.
Run the deactivate command to remove the specified stack from the list of available application types, without deleting it from the Kabanero instance.
This command is useful in a case where you have cloned a collection and customized it for your business needs. Deactivation keeps the base collection in the app hub. The base collection continues to be updated and the updates percolate up to your cloned collection. To restore a deactivated collection, run the kabanero refresh command.`,
This command is useful in a case where you have cloned a stack and customized it for your business needs. Deactivation keeps the base stack in the app hub. The base stack continues to be updated and the updates percolate up to your cloned stack. To restore a deactivated stack, run the kabanero refresh command.`,
RunE: func(cmd *cobra.Command, args []string) error {
// fmt.Println("deactivate called")
collectionName := args[0]
stackName := args[0]
version := args[1]
url := getRESTEndpoint("v1/stacks/" + collectionName + "/versions/" + version)
url := getRESTEndpoint("v1/stacks/" + stackName + "/versions/" + version)
resp, err := sendHTTPRequest("DELETE", url, nil)
if err != nil {
Debug.log("deactivate: Error on sendHTTPRequest:")
Expand Down
2 changes: 1 addition & 1 deletion cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ func homeDir() string {

var rootCmd = &cobra.Command{
Use: "kabanero",
Short: "This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero collections that are used by developers to create governed applications for their business.",
Short: "This repo defines a command line interface used by the enterprise, solution, or application architect who defines and manages the kabanero stacks that are used by developers to create governed applications for their business.",
Long: `**kabanero** is a command line interface for managing the stacks in a Kabanero
environment, as well as to on-board the people that will use
the environment to build applications.
Expand Down
6 changes: 3 additions & 3 deletions cmd/sync.go
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,10 @@ func sendHTTPRequest(method string, url string, jsonBody []byte) (*http.Response
// syncCmd represents the sync command
var syncCmd = &cobra.Command{
Use: "sync",
Short: "sync the collections list",
Long: `Run the kabanero sync command to synchronize the list of kabanero instance collections with the curated collection from github. This will activate/deactivate as well as update versions of the kabanero collections to reflect the state of the curated collection.
Short: "sync the stack list",
Long: `Run the kabanero sync command to synchronize the list of kabanero instance stacks with the curated stacks from github. This will activate/deactivate as well as update versions of the kabanero stacks to reflect the state of the curated stacks.
See also kabanero deactivate.
Modifications to the curated collection may be slow to replicate in git hub and therefore may not be reflected immediately in KABANERO LIST or SYNC display output
Modifications to the curated stacks may be slow to replicate in git hub and therefore may not be reflected immediately in KABANERO LIST or SYNC display output
`,
RunE: func(cmd *cobra.Command, args []string) error {
url := getRESTEndpoint("v1/stacks")
Expand Down

0 comments on commit c7e2099

Please sign in to comment.