Skip to content
This repository was archived by the owner on Jan 21, 2020. It is now read-only.

Commit 5a9cddb

Browse files
ohmkDavid Chung
authored andcommitted
fix typo and some links (#397)
Signed-off-by: Kei Ohmura <[email protected]>
1 parent f00e0d3 commit 5a9cddb

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ fields follow the pattern of `<some_key>` and `Properties` as shown above.
134134

135135
The `Allocation` determines how the Group is managed. Allocation has two properties:
136136
- `Size`: an integer for the number of instances to maintain in the Group
137-
- `LogicalIDs`: a list of string identifiers, one will be associated wih each Instance
137+
- `LogicalIDs`: a list of string identifiers, one will be associated with each Instance
138138

139139
Exactly one of these fields must be set, which defines whether the Group is treated as 'cattle' (`Size`) or 'pets'
140140
(`LogicalIDs`). It is up to the Instance and Flavor plugins to determine how to use `LogicalID` values.

docs/plugins/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The default plugin directory is `~/.infrakit/plugins`, and can be overridden wit
1414
Note that multiple instances of a plugin may run, provided they have different names for discovery. This may be useful,
1515
for example, if a plugin can be configured to behave differently. For example:
1616

17-
The CLI shows which plugins are [discoverable](cmd/cli/README.md#list-plugins).
17+
The CLI shows which plugins are [discoverable](../../cmd/cli/README.md#list-plugins).
1818

1919
## Plugin types
2020
### Group
@@ -32,7 +32,7 @@ Since _InfraKit_ emphasizes on declarative infrastructure, there are no operatio
3232
state to another. Instead, you _declare_ your desired state of the infrastructure. _InfraKit_ is responsible
3333
for converging towards, and maintaining, that desired state.
3434

35-
Therefore, a [group plugin](pkg/spi/group/spi.go) manages Groups of Instances and exposes the operations that are of
35+
Therefore, a [group plugin](../../pkg/spi/group/spi.go) manages Groups of Instances and exposes the operations that are of
3636
interest to a user:
3737

3838
+ commit a group configuration, to start managing a group
@@ -49,7 +49,7 @@ infrastructure management system. This would allow you to use _InfraKit_ toolin
4949
different infrastructure using the same interface.
5050

5151
### Instance
52-
Instances are members of a group. An [instance plugin](pkg/spi/instance/spi.go) manages some physical resource instances.
52+
Instances are members of a group. An [instance plugin](../../pkg/spi/instance/spi.go) manages some physical resource instances.
5353
It knows only about individual instances and nothing about Groups. Instance is technically defined by the plugin, and
5454
need not be a physical machine at all.
5555

@@ -62,7 +62,7 @@ persistent, stable state. These properties are captured via the _flavors_ of the
6262

6363
### Flavor
6464
Flavors help distinguish members of one group from another by describing how these members should be treated.
65-
A [flavor plugin](pkg/spi/flavor/spi.go) can be thought of as defining what runs on an Instance.
65+
A [flavor plugin](../../pkg/spi/flavor/spi.go) can be thought of as defining what runs on an Instance.
6666
It is responsible for dictating commands to run services, and check the health of those services.
6767

6868
Flavors allow a group of instances to have different characteristics. In a group of cattle,
@@ -80,30 +80,30 @@ Over time, we would prefer to phase out reference Plugins that appear to provide
8080
are developed independently. For this reason, please [file an issue](https://github.com/docker/infrakit/issues/new)
8181
to start a discussion before contributing to these plugins with non-trivial code.
8282

83-
| plugin | type | description |
84-
|:-----------------------------------------------------|:---------|:----------------------------------------|
85-
| [swarm](pkg/example/flavor/swarm) | flavor | runs Docker in Swarm mode |
86-
| [vanilla](pkg/example/flavor/vanilla) | flavor | manual specification of instance fields |
87-
| [zookeeper](pkg/example/flavor/zookeeper) | flavor | run an Apache ZooKeeper ensemble |
88-
| [infrakit/file](pkg/example/instance/file) | instance | useful for development and testing |
89-
| [infrakit/terraform](pkg/example/instance/terraform) | instance | creates instances using Terraform |
90-
| [infrakit/vagrant](pkg/example/instance/vagrant) | instance | creates Vagrant VMs |
83+
| plugin | type | description |
84+
|:--------------------------------------------------------|:---------|:----------------------------------------|
85+
| [swarm](../../examples/flavor/swarm) | flavor | runs Docker in Swarm mode |
86+
| [vanilla](../../examples/flavor/vanilla) | flavor | manual specification of instance fields |
87+
| [zookeeper](../../examples/flavor/zookeeper) | flavor | run an Apache ZooKeeper ensemble |
88+
| [infrakit/file](../../examples/instance/file) | instance | useful for development and testing |
89+
| [infrakit/terraform](../../examples/instance/terraform) | instance | creates instances using Terraform |
90+
| [infrakit/vagrant](../../examples/instance/vagrant) | instance | creates Vagrant VMs |
9191

9292

9393
### Supported implementations
9494
The following Plugins are supported for active development. Note that these Plugins may not be part of the InfraKit
9595
project, so please double-check where the code lives before filing InfraKit issues.
9696

97-
| plugin | type | description |
98-
|:--------------------------------------------------------------|:---------|:------------------------------------------------------|
99-
| [infrakit/group](cmd/group) | group | supports Instance and Flavor plugins, rolling updates |
100-
| [docker/infrakit.aws](https://github.com/docker/infrakit.aws) | instance | creates Amazon EC2 instances |
97+
| plugin | type | description |
98+
|:--------------------------------------------------------------------|:---------|:------------------------------------------------------|
99+
| [infrakit/group](../../cmd/group) | group | supports Instance and Flavor plugins, rolling updates |
100+
| [docker/infrakit.aws](https://github.com/docker/infrakit.aws) | instance | creates Amazon EC2 instances |
101101

102102
Have a Plugin you'd like to share? Submit a Pull Request to add yourself to the list!
103103

104104
### Creating a plugin
105105
A plugin must be an HTTP server that implements one of the plugin [APIs](#apis), listening on a Unix socket. While
106-
a plugin can be written in any programming language, [utilities](pkg/rpc) are available as libraries to simplify Plugin
106+
a plugin can be written in any programming language, [utilities](../../pkg/rpc) are available as libraries to simplify Plugin
107107
development in Go. Our [reference implementations](#reference-implementations) should provide a good starting point
108108
for building a new plugin using these utilities.
109109

0 commit comments

Comments
 (0)