Skip to content

Commit

Permalink
Bump version to 1.1.0
Browse files Browse the repository at this point in the history
Also, remove placemat-connect.
  • Loading branch information
ymmt2005 committed Nov 6, 2018
1 parent 8ace6fe commit 806f299
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 105 deletions.
14 changes: 12 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]

## [1.1.0] - 2018-11-06

### Added
- [`pmctl`](docs/pmctl.md) is a command-line client to control placemat.

### Removed
- `placemat-connect` as it is replaced by `pmctl`.


## [1.0.1] - 2018-10-23
### Changed
- Use cybozu-go/well instead of cybozu-go/cmd
Expand All @@ -13,6 +22,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
### Added
- Many things. See git log.

[Unreleased]: https://github.com/cybozu-go/placemat/compare/v1.0.1...HEAD
[1.0.1]: https://github.com/cybozu-go/placemat/compare/v0.1...v1.0.1
[Unreleased]: https://github.com/cybozu-go/placemat/compare/v1.1.0...HEAD
[1.1.0]: https://github.com/cybozu-go/placemat/compare/v1.0.1...v1.1.0
[1.0.1]: https://github.com/cybozu-go/placemat/compare/v1.0.0...v1.0.1
[1.0.0]: https://github.com/cybozu-go/placemat/compare/v0.1...v1.0.0
29 changes: 4 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ Usage
This project provides these commands:

* `placemat` is the main tool to build networks and virtual machines.
* `placemat-connect` is a utility to connect to VM serial console.
* `pmctl` is a utility tool to control VMs and Pods.

### placemat command
Expand Down Expand Up @@ -89,25 +88,6 @@ if `sudo` is used for `placemat`. If `sudo` is not used, cache directory will b
the same as `-data-dir`.
`-force` is used for forced run. Remaining garbage, for example virtual networks, mounts, socket files will be removed.

### placemat-connect command

**DEPRECATED** : `placemat-connect` will be replaced by `pmctl node enter`.

If placemat starts without `-graphic` option, VMs will have no graphic console.
Instead, they have serial consoles exposed via UNIX domain sockets.

`placemat-connect` is a tool to connect to the serial console.

```console
$ placemat-connect [-run-dir=/tmp] your-vm-name

Options:
-run-dir
the directory specified for placemat by -run-dir.
```

**To exit** from the console, press Ctrl-Q, Ctrl-X in this order.

### pmctl command

`pmctl` is a command line tool to control VMs, Pods and Networks.
Expand All @@ -121,7 +101,7 @@ Getting started

- [QEMU][]
- [OVMF][] for UEFI.
- [picocom](https://github.com/npat-efault/picocom) for `placemat-connect`
- [picocom](https://github.com/npat-efault/picocom) for `pmctl`.
- [rkt][] for `Pod` resource.

For Ubuntu or Debian, you can install them as follows:
Expand All @@ -140,11 +120,10 @@ $ sudo dpkg -i rkt_1.30.0-1_amd64.deb

### Install placemat

Install `placemat` and `placemat-connect`:
Install `placemat` and `pmctl`:

```console
$ go get -u github.com/cybozu-go/placemat/pkg/placemat
$ go get -u github.com/cybozu-go/placemat/pkg/placemat-connect
$ go get -u github.com/cybozu-go/placemat/pkg/pmctl
```

Expand All @@ -158,10 +137,10 @@ To launch placemat from YAML files, run it with `sudo` as follows:
$ sudo $GOPATH/bin/placemat cluster.yml
```

To connect to a serial console of a VM, use `placemat-connect`:
To connect to a serial console of a VM, use `pmctl node enter`:

```console
$ sudo $GOPATH/bin/placemat-connect VM
$ sudo $GOPATH/bin/pmctl node enter VM
```

This will launch `picocom`. To exit, type `Ctrl-Q`, then `Ctrl-X`.
Expand Down
4 changes: 2 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ provisioned by the boot server, they will boot [iPXE][] provided from boot
server.

```console
$ sudo placemat-connect boot # login with ubuntu/ubuntu
$ sudo placemat-connect worker-1
$ sudo pmctl node enter boot # login with ubuntu/ubuntu
$ sudo pmctl node enter worker-1
```

[Ubuntu Cloud Image]: https://cloud-images.ubuntu.com/
Expand Down
76 changes: 0 additions & 76 deletions pkg/placemat-connect/main.go

This file was deleted.

0 comments on commit 806f299

Please sign in to comment.