Skip to content

Commit e7989d9

Browse files
committed
rename hyper to hyperctl
Signed-off-by: Lai Jiangshan <[email protected]>
1 parent 8aaaca3 commit e7989d9

26 files changed

+43
-43
lines changed

get_started/install/build.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ And make sure you have `go` (>= 1.4) and `autotools`, develop files of
2020

2121
(If you want to build without Xen support, use configure option `--without-xen`.)
2222

23-
Then you can get the binaries `hyperd` daemon and `hyper` CLI tool.
23+
Then you can get the binaries `hyperd` daemon and `hyperctl` CLI tool.
2424

2525
#### Build Xen from source
2626

get_started/install/mac.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To install Hyper on Mac OS X, you need first to install VirtualBox 5.0, then dow
1414
The Hyper Mac package contains
1515

1616
- `hyperd` Daemon, which could be controled with `launchctl`
17-
- `hyper` cli tool with
17+
- `hyperctl` command line control tool with
1818
- An uninstall shell script, located under `/opt/hyper/bin/uninstall-hyper.sh`
1919

2020
> If you need to uninstall hyper and clean all existing images and containers, call the uninstall script with `--purge` flag.

get_started/lifecycle.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,38 +10,38 @@ In Hyper, a Pod has two states:
1010

1111
A Pod can be launched either explicitly:
1212

13-
[root@user ~:]# hyper run -p podfile.json
13+
[root@user ~:]# hyperctl run -p podfile.json
1414

1515
Or, implicitly:
1616

17-
[root@user ~:]# hyper run -t ubuntu
17+
[root@user ~:]# hyperctl run -t ubuntu
1818

1919
In both cases, Pods and VMs are indivisible. Hyper will automatically provision a new VM instance to host the Pod, and the Pod will be `Running`.
2020

2121
However, you can also create a Pod, but without an underlying VM. In such case, the pod stays in `Created` state.
2222

23-
[root@user ~:]# hyper create -p podfile.json
23+
[root@user ~:]# hyperctl create -p podfile.json
2424

2525
There are two options to start the pod:
2626

27-
[root@user ~:]# hyper start pod_id
27+
[root@user ~:]# hyperctl start pod_id
2828

2929
The `START` command will trigger a VM provisioned, and allocate the new VM to the Pod. Alternatively, you can choose to `REPLACE` a running one:
3030

31-
[root@user ~:]# hyper replace -o old_pod_id -n new_pod_id
31+
[root@user ~:]# hyperctl replace -o old_pod_id -n new_pod_id
3232

3333
In this case, the VM instance will be de-associated from `old_pod_id` and re-assign to `new_pod_id`. Since the VM is already present, `REPLACE` is a faster option to launch a pod, than `RUN` and `START`.
3434

3535
> Note: `old_pod_id` must be running.
3636
3737
When you `STOP` a Pod, the underlying VM instance will be terminated:
3838

39-
[root@user ~:]# hyper stop pod_id
39+
[root@user ~:]# hyperctl stop pod_id
4040

4141
When stopped, the Pod will return to the `Created` state.
4242

4343
To permantly destroy a Pod, you need to `RM` it:
4444

45-
[root@user ~:]# hyper rm pod_id
45+
[root@user ~:]# hyperctl rm pod_id
4646

4747
Hyper will (stop if neccessary, then) remove the Pod definition and its storage.

how_it_works.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22

33
Hyper has four components:
44

5-
- CLI: ***hyper***
5+
- CLI: ***hyperctl***
66
- Daemon: ***hyperd*** (with REST APIs)
77
- Guest Kernel: ***hyperkernel***
88
- Guest Init Service: ***hyperstart***
99

1010
On a physical Linux host:
1111

12-
[root@user ~:]# hyper pull nginx:latest
13-
[root@user ~:]# hyper run nginx:latest
12+
[root@user ~:]# hyperctl pull nginx:latest
13+
[root@user ~:]# hyperctl run nginx:latest
1414

1515
Upon ***RUN***, Hyper launches the Docker images with a new VM instance, instead of Linux containers:
1616

1717
[root@user ~:]# docker ps
1818
[root@user ~:]#
19-
[root@user ~:]# hyper list
19+
[root@user ~:]# hyperctl list
2020
......
2121
Done
2222

pod/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The key idea behind **Pod** is that in a microservice architecture usually invol
1212

1313
In Hyper, a pod consists of a colocated group of AppContainer images, deployed as a single unit in one Hyper instance.
1414

15-
[root@user ~:]# hyper run -p nginx rails logstash cronjob
15+
[root@user ~:]# hyperctl run -p nginx rails logstash cronjob
1616

1717
Inside of the instance, multiple applications from different images share the namespaces: ***`PID`***, ***`Network`***, ***`IPC`***, ***`UTS`***, ***`User`***. Pod helps to provide a familiar view of a tranditional OS to applications, rather than the philosophy of "*one process per container*":
1818

reference/attach.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Attach a specified container in a Pod to TTY
44

55
Usage:
6-
hyper attach CONTAINER
6+
hyperctl attach CONTAINER
77

88
Help Options:
99
-h, --help Show this help message

reference/build.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Build a new image from the source code at PATH
44

55
```
66
Usage:
7-
hyper build [OPTIONS] PATH
7+
hyperctl build [OPTIONS] PATH
88
99
Application Options:
1010
-t, --tag="" Repository name (and optionally a tag) to be applied to the resulting image in case of success
@@ -14,5 +14,5 @@ Help Options:
1414
-h, --help Show this help message
1515
1616
Example:
17-
hyper build -t test /dockerfile/path/
17+
hyperctl build -t test /dockerfile/path/
1818
```

reference/cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
```
44
Usage:
55
6-
hyper [OPTIONS] COMMAND [ARGS...]
6+
hyperctl [OPTIONS] COMMAND [ARGS...]
77
88
Command:
99
@@ -30,5 +30,5 @@ Help Options:
3030
3131
-h, --help Show this help message
3232
33-
Run 'hyper COMMAND --help' for more information on a command.
33+
Run 'hyperctl COMMAND --help' for more information on a command.
3434
```

reference/commit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Create a new image from a container's changes
66

77
```
88
Usage:
9-
hyper commit [OPTIONS] CONTAINER [REPOSITORY[:TAG]]
9+
hyperctl commit [OPTIONS] CONTAINER [REPOSITORY[:TAG]]
1010
1111
Application Options:
1212
-a, --author="" Author (e.g., "Hello World <[email protected]>")

reference/containers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
- `name`: the identifier of a container; a random id will be given if absent
44

5-
- `image`: in the form `[registry]/image[:tag]`; hyper will automatically pull the image if missing
5+
- `image`: in the form `[registry]/image[:tag]`; hyperctl will automatically pull the image if missing
66

77
- `command`: the shell command to run when the container starts
88

0 commit comments

Comments
 (0)