Skip to content

Commit

Permalink
Rename authz to authorization
Browse files Browse the repository at this point in the history
Signed-off-by: Antonio Murdaca <[email protected]>
  • Loading branch information
runcom committed Feb 6, 2016
1 parent 2bce64a commit f4bd5d2
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

A collection of helper packages to extend Docker Engine in Go

Plugin type | Documentation | Description
------------|---------------|--------------------------------------------------
Authz | N/A | Extend API authorization mechanism
Network | [Link](https://docs.docker.com/engine/extend/plugins_network/) | Extend network management
Volume | [Link](https://docs.docker.com/engine/extend/plugins_volume/) | Extend persistent storage
Plugin type | Documentation | Description
--------------|---------------|--------------------------------------------------
Authorization | N/A | Extend API authorization mechanism
Network | [Link](https://docs.docker.com/engine/extend/plugins_network/) | Extend network management
Volume | [Link](https://docs.docker.com/engine/extend/plugins_volume/) | Extend persistent storage

See the [understand Docker plugins documentation section](https://docs.docker.com/engine/extend/plugins/).
14 changes: 7 additions & 7 deletions authz/README.md → authorization/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# Docker authz extension api.
# Docker authorization extension api.

Go handler to create external authz extensions for Docker.
Go handler to create external authorization extensions for Docker.

## Usage

This library is designed to be integrated in your program.

1. Implement the `authz.Plugin` interface.
2. Initialize a `authz.Handler` with your implementation.
3. Call either `ServeTCP` or `ServeUnix` from the `authz.Handler`.
1. Implement the `authorization.Plugin` interface.
2. Initialize a `authorization.Handler` with your implementation.
3. Call either `ServeTCP` or `ServeUnix` from the `authorization.Handler`.

### Example using TCP sockets:

```go
p := MyAuthZPlugin{}
h := authz.NewHandler(p)
h := authorization.NewHandler(p)
h.ServeTCP("test_plugin", ":8080")
```

### Example using Unix sockets:

```go
p := MyAuthZPlugin{}
h := authz.NewHandler(p)
h := authorization.NewHandler(p)
h.ServeUnix("root", "test_plugin")
```

Expand Down
2 changes: 1 addition & 1 deletion authz/api.go → authorization/api.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package authz
package authorization

import (
"net/http"
Expand Down
2 changes: 1 addition & 1 deletion authz/api_test.go → authorization/api_test.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package authz
package authorization

import "testing"

Expand Down

0 comments on commit f4bd5d2

Please sign in to comment.