Skip to content

Commit c240624

Browse files
committed
docs update
1 parent b35f388 commit c240624

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
# Ray Configuration Generator For IBM-Cloud Services
1+
# Ray VPC allocator / Configuration Generator For IBM VPC
22

3-
ibm-ray-config is a CLI tool that greatly simplifies user experience by generating Ray configuration files for IBM services.
4-
Currently supporting only IBM Virtual Private Cloud (VPC).
3+
`ibm-ray-config` is a CLI tool that seamlessly allocates and registers VPC resources, such as: subnets, gateways, ips, ssh keys and security groups rules to generate Ray configuration files for IBM VPC.
54

65
## Setup
76

@@ -82,4 +81,8 @@ config_file = generate_config(iam_api_key=api_key, region=region)
8281
### Test and Usage
8382
Attention: to run multiple clusters under the same VPC, make sure their cluster names (`cluster_name` in the config file) are unique.
8483

85-
To deploy a Ray cluster with the configuration created, please use the <a href="https://github.com/project-codeflare/ibm-vpc-ray-connector"> ibm-vpc-ray-connector </a>. Follow the instructions via the provided link to test your configuration files.
84+
To deploy a Ray cluster with the configuration created, please use the <a href="https://github.com/project-codeflare/ibm-vpc-ray-connector"> ibm-vpc-ray-connector </a>. Follow the instructions via the provided link to test your configuration files.
85+
86+
## Execution Example
87+
![part1](doc-assets/example1.png?raw=true)
88+
![part2](doc-assets/example2.png?raw=true)

doc-assets/example1.png

119 KB
Loading

doc-assets/example2.png

124 KB
Loading

0 commit comments

Comments
 (0)