Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CLI-reference related to service catalog #677

Merged
merged 2 commits into from
Aug 30, 2018
Merged

Add CLI-reference related to service catalog #677

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
136dd92
Add CLI-reference related to service catalog
surajnarwade Aug 29, 2018
eea727b
Updated cli structure in README.md
surajnarwade Aug 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,35 +130,45 @@ odo --verbose : Odo (Openshift Do)
list : Lists all the applications
set : Set application as active
catalog : Catalog related operations
list : List all available component types.
search : Search component type in catalog
completion : Output shell completion code
list : List all available component & service types.
components : List all available component types.
services : Lists all the services from service catalog
search : Search available component & service types.
components : Search component type in catalog
services : Search service type in catalog
component --short : Components of application.
get --short : Get currently active component
set : Set active component.
create --binary --git --local : Create a new component
create --binary --git --local --port : Create a new component
delete --force : Delete an existing component
describe : Describe the given component
link --component : Link target component to source component
list : List all components in the current application
log : Retrieve the log for the given component.
log --follow : Retrieve the log for the given component.
project --short : Perform project operations
create : Create a new project
get --short : Get the active project
list : List all the projects
set --short : Set the current active project
push --local : Push source code to a component
service : Perform service catalog operations
create : Create a new service
delete --force : Delete an existing service
list : List all services in the current application
storage : Perform storage operations
create --component --path --size : Create storage and mount to a component
delete --force : Delete storage from component
list --component : List storage attached to a component
list --all --component : List storage attached to a component
mount --component --path : mount storage to a component
unmount --component : Unmount storage from the current component
unmount --component : Unmount storage from the given path or identified by its name, from the current component
update --binary --git --local : Update the source code path of a component
url : Expose component to the outside world
create : Create a URL for a component
delete --force : Delete a URL
create --application --component --port : Create a URL for a component
delete --component --force : Delete a URL
list --application --component : List URLs
utils : Utilities for completion and terminal commands
completion : Output shell completion code
terminal : Add Odo terminal support to your development environment
version : Print the client version information
watch : Watch for changes, update component on change
```
Expand Down
45 changes: 39 additions & 6 deletions docs/cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Find more information at https://github.com/redhat-developer/odo
| [log](#log) | Retrieve the log for the given component. |
| [project](#project) | Perform project operations |
| [push](#push) | Push source code to a component |
| [service](#service) | Perform service catalog operations |
| [storage](#storage) | Perform storage operations |
| [update](#update) | Update the source code path of a component |
| [url](#url) | Expose component to the outside world |
Expand All @@ -53,8 +54,12 @@ odo --alsologtostderr --log_backtrace_at --log_dir --logtostderr --skip-connecti
list : Lists all the applications
set : Set application as active
catalog : Catalog related operations
list : List all available component types.
search : Search component type in catalog
list : List all available component & service types.
components : List all available component types.
services : Lists all the services from service catalog
search : Search available component & service types.
components : Search component type in catalog
services : Search service type in catalog
component --short : Components of application.
get --short : Get currently active component
set : Set active component.
Expand All @@ -70,6 +75,10 @@ odo --alsologtostderr --log_backtrace_at --log_dir --logtostderr --skip-connecti
list : List all the projects
set --short : Set the current active project
push --local : Push source code to a component
service : Perform service catalog operations
create : Create a new service
delete --force : Delete an existing service
list : List all services in the current application
storage : Perform storage operations
create --component --path --size : Create storage and mount to a component
delete --force : Delete storage from component
Expand Down Expand Up @@ -127,13 +136,16 @@ Performs application operations related to your OpenShift project.

```sh
# Get the supported components
odo catalog list
odo catalog list components

# Search for a supported component
odo search nodejs
# Get the supported services from service catalog
odo catalog list services

# Search for a component
odo catalog search pyt
odo catalog search components python

# Search for a service
odo catalog search service mysql

```

Expand Down Expand Up @@ -326,6 +338,27 @@ Perform project operations

Push source code to a component.

## service

`service`

> Example using service

```sh
# Create new mysql-persistent service from service catalog.
odo service create mysql-persistent

# Delete service named 'mysql-persistent'
odo service delete mysql-persistent

# List all services in the application
odo service list

```


Perform service catalog operations, Limited to template service broker only.

## storage

`storage`
Expand Down