Skip to content

Commit d4d6323

Browse files
committed
doc: update README to mention profiles
1 parent 0dc7948 commit d4d6323

File tree

1 file changed

+42
-21
lines changed

1 file changed

+42
-21
lines changed

README.md

+42-21
Original file line numberDiff line numberDiff line change
@@ -9,39 +9,60 @@
99
<img src="./images/codeflare_cli.svg" width="110" height="110" align="left">
1010
</p>
1111

12-
<a href="https://asciinema.org/a/518021" target="_blank"><img src="https://asciinema.org/a/518021.svg" width="300" align="right"/></a>
12+
[CodeFlare](https://codeflare.dev) simplifies the integration, scaling
13+
and acceleration of complex multi-step analytics and machine learning
14+
pipelines on the cloud.
1315

14-
[CodeFlare](https://codeflare.dev) is a framework to simplify the
15-
integration, scaling and acceleration of complex multi-step analytics
16-
and machine learning pipelines on the cloud.
17-
18-
This repository is home to the open source CodeFlare CLI,
19-
`codeflare`. This CLI helps you to submit and observe jobs in a
20-
Kubernetes cluster.
16+
This repository houses the CodeFlare CLI, `codeflare`, which helps
17+
you to submit and observe jobs in a Kubernetes cluster.
2118

2219
[Check out some use cases in motion](./docs/scenarios/README.md#readme).
2320

24-
<a href="https://asciinema.org/a/517993" target="_blank"><img src="https://asciinema.org/a/517993.svg" width="300" align="right"/></a>
21+
<a href="https://asciinema.org/a/518021" target="_blank"><img src="https://asciinema.org/a/518021.svg" height="175"/></a>
22+
<a href="https://asciinema.org/a/517989" target="_blank"><img src="https://asciinema.org/a/517989.svg" height="175"/></a>
23+
<a href="https://asciinema.org/a/517993" target="_blank"><img src="https://asciinema.org/a/517993.svg" height="175"/></a>
24+
25+
## How `codeflare` Works
26+
27+
The `codeflare` CLI is programmed with a set of tasks. Each task knows
28+
how to **guide** you through the complexities of running against a
29+
remote cluster. For example, `codeflare` tasks include submitting a
30+
Ray job to a Kubernetes cluster, or observing such a running job.
31+
32+
The way `codeflare` guides you is by asking you questions. It tries
33+
to formulate each question as a choice from a list of
34+
possibilities. In this example, it attempts to list your available
35+
Kubernetes clusters, and you need only select from that list. It does
36+
the same kind of thing for S3 data (e.g. showing you a list of
37+
available S3 buckets). Some questions require more free-form
38+
responses. For example, when asking for the resource requirements of
39+
your job, it presents a form that you can edit to specify how many
40+
GPUs you need.
41+
42+
### Managing Profiles
43+
44+
The `codeflare` CLI remembers your answers to these questions in a
45+
**profile**. This allows you to easily re-run a task using the same
46+
answers as before: `codeflare -y/--yes`, which auto-accepts your prior
47+
answers, as long as those answers are still valid. To run with a
48+
profile name of your choosing, use the `-p/--profile` command line
49+
option. In doing so, you may thus quickly switch between variants,
50+
e.g. different input data, or different Kubernetes clusters.
51+
52+
To manage your profiles, use the `codeflare profile
53+
<list|get|delete|clone>` command lines.
2554

2655
## Installation
2756

28-
Please visit the
57+
Visit the
2958
[Releases](https://github.com/project-codeflare/codeflare-cli/releases/latest)
30-
page to download the package for your platform, unpack it, and place
31-
the enclosed `bin/` directory on your `PATH`. macOS users may use
32-
[HomeBrew](https://brew.sh/) to expedite installation:
59+
page. Download the package for your platform, unpack it, and place the
60+
enclosed `bin/` directory on your `PATH`. macOS users may use
61+
[HomeBrew](https://brew.sh/):
3362

3463
brew tap project-codeflare/codeflare-cli https://github.com/project-codeflare/codeflare-cli
3564
brew install codeflare
3665

37-
<a href="https://asciinema.org/a/517989" target="_blank"><img src="https://asciinema.org/a/517989.svg" width="300" align="right"/></a>
38-
39-
## Command Line Options
40-
41-
- `-y/--yes`: Repeat a prior run using all of the same answers, without any prompts.
42-
- `-p/--profile`: Use a named profile. By default, your choices will be stored in a profile named "default".
43-
- `-V`: this will provide verbose output of the tool's operation.
44-
4566
## Contributing
4667

4768
Want to help out? Check out the [developer guide](./docs/development/README.md).

0 commit comments

Comments
 (0)