Skip to content

Commit

Permalink
de-hyphenate old mentions of ziti-controller as 'ziti controller'
Browse files Browse the repository at this point in the history
  • Loading branch information
qrkourier committed Apr 13, 2024
1 parent 5dab819 commit d16ec86
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 48 deletions.
2 changes: 1 addition & 1 deletion controller/server/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ func (c *Controller) checkEdgeInitialized() {

if admin == nil {
if !c.AppEnv.GetHostController().IsRaftEnabled() {
log.Fatal("the Ziti Edge has not been initialized via 'ziti-controller edge init', no default admin exists")
log.Fatal("the Ziti Edge has not been initialized via 'ziti controller edge init', no default admin exists")
}

if first {
Expand Down
4 changes: 2 additions & 2 deletions controller/subcmd/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,10 @@ func NewEdgeInitializeCmd(versionProvider versions.VersionProvider) *cobra.Comma
cmd := &cobra.Command{
Use: "init <config> [-p]",
Aliases: []string{"initialize"},
Example: "ziti-controller edge init controller.yml -u admin -p o93wjh5n",
Example: "ziti controller edge init controller.yml -u admin -p o93wjh5n",
Args: func(cmd *cobra.Command, args []string) error {
if len(args) != 1 {
return errors.New("config file not specified: ziti-controller edge init <config>")
return errors.New("config file not specified: ziti controller edge init <config>")
}

return nil
Expand Down
34 changes: 17 additions & 17 deletions doc/001-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ and management of endpoints that make use of the Ziti SDK. The Ziti SDK can be b
ingress and egress to the Ziti overlay network as well as to provide application specific networking to an individual
application. Enabling the Edge features is optional.

Both the Fabric and Edge features are built into the ziti-controller and ziti-router binaries.
Both the Fabric and Edge features are built into the ziti binary.

## Ziti Controller

The Ziti Controller (ziti-controller) is the main server component of a Ziti environment. It is the first piece of Ziti
The Ziti Controller is the main server component of a Ziti environment. It is the first piece of Ziti
that must be setup and configured. The controller houses all the router, service, and management data necessary
to run a Ziti environment. There is one, and only one, controller per Ziti environment.

Expand Down Expand Up @@ -49,42 +49,42 @@ Below is an outline of all the applications that are generated from this reposit
The following binaries are used to deploy long running servers that route traffic and manage the
configuration of a Ziti environment.

| Binary Name | Description|
| Command | Description|
|-------------------| -----------|
| ziti-controller | Runs a central server necessary for Ziti environments|
| ziti-router | Runs a server capable of ingress'ing and egress'ing Ziti traffic standalone or as a mesh|
| ziti controller | Runs a central server necessary for Ziti environments|
| ziti router | Runs a server capable of ingress'ing and egress'ing Ziti traffic standalone or as a mesh|

### Tools

The following binaries provide utility or testing functionality.
The following commands provide utility or testing functionality.

| Binary Name | Description|
| Command | Description|
|-------------------| -----------|
| ziti-enroller | Provides enrollment processing features for executables that do not directly support enrollment
| ziti-fabric-gw | Provides JSON RCP web service access to Ziti fabric management features
| ziti-fabric-test | The Ziti Fabric Toolbox which is used to test deployed fabric components|
| ziti edge enroll | Provides enrollment processing features for executables that do not directly support enrollment|
| ziti fabric inspect | Observe Ziti Fabric runtime values |

### Management

The following binaries are used to configure and manage a Ziti environment via command line interactions.

| Binary Name | Description|
| Command | Description|
|-------------------| -----------|
| ziti-fabric | Provides command line access to Ziti Fabric management features|
| ziti | Provides command line access to Ziti management features|
| ziti fabric | Provides command line access to Ziti Fabric management features|
| ziti edge | Provides command line access to Ziti management features|

## Endpoint Clients

The following binaries are Ziti endpoint clients which have the Ziti SDK built into them and can connected to an
edge router. Endpoint clients can be application specific or act as a bridge to other applications, hosts, or underlay
networks.

| Binary Name | Description|
| Command | Description|
|-------------------| -----------|
| ziti-tunnel | Provides the ability to intercept traffic to route traffic across Ziti|
| ziti tunnel | Provides the ability to intercept traffic to route traffic across Ziti|

All of the above binaries are cross platform compatible, except ziti-tunnel which is currently Linux only.
All of the above binaries are cross platform compatible, except `ziti tunnel` which is currently Linux-only.

## Further Exploration

Continue your OpenZiti exploration in [the next article about getting set up for local development](./002-local-dev.md) and building the apps from source.
Continue your OpenZiti exploration in [the next article about getting set up for local development](./002-local-dev.md)
and building the apps from source.
13 changes: 4 additions & 9 deletions doc/002-local-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ grep -Po '^go\s+\K\d+\.\d+(\.\d+)?$' go.mod

## Build and Install All Applications

This repo contains several Go applications, e.g. ziti-controller, ziti-router. These applications were reorganized as subcommands of the `ziti` CLI application, so it's no longer necessary to build the discrete binaries. Only the `ziti` CLI is necessary. The easiest way to build and install `ziti` in `${GOPATH}/bin` is:
This repo contains one main Go application, i.e. `ziti` with many subcommands. The easiest way to build and install `ziti` in `${GOPATH}/bin` is:

```bash
# build and install ziti CLI
Expand All @@ -23,20 +23,15 @@ If you add `${GOPATH}/bin` to your executable search `${PATH}` then you may imme

```bash
$ ziti version
NAME VERSION
ziti v0.0.0
ziti-controller not installed
ziti-prox-c not installed
ziti-router not installed
ziti-tunnel not installed
ziti-edge-tunnel v0.20.18-local
v0.0.0
```

## Build ziti CLI
## Save Build Artifact Elsewhere

```bash
# build the binary without installing in GOPATH
go build -o ./build/ziti ./ziti/

# execute the binary
./build/ziti version
```
Expand Down
4 changes: 2 additions & 2 deletions doc/ops-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ Use unix sockets to limit security risk. Only the user on the machine who starte

Examples:

1. `ziti-controller --cli-agent-addr unix:/tmp/my-special-agent-file.sock`
2. `ziti-controller --cli-agent-addr tcp:127.0.0.1:10001`
1. `ziti controller --cli-agent-addr unix:/tmp/my-special-agent-file.sock`
2. `ziti controller --cli-agent-addr tcp:127.0.0.1:10001`

### Disabling the Agent

Expand Down
33 changes: 16 additions & 17 deletions quickstart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,27 @@ simple networks. As with any solution it is common for additional changes to the
after expanding beyond the initial setup.

There are three different modes contained in these folders. One mode allows you very quickly get setup and
run the two main components of a OpenZiti network: ziti-controller and ziti-router. The [Express](#express)
run the two main components of a OpenZiti network: ziti-controller and ziti-router. The [Express](#express)
configuration will guide you here.

The remaining two modes all use [docker](https://docs.docker.com/get-started/) to establish environments.
The first of the docker-based quickstarts uses [docker-compose](https://docs.docker.com/compose/).
You will find a fully defined OpenZiti Network in a compose file which should allow you to understand better
and learn how multiple routers can be linked to form a mesh network or serve as an initial
template to build your own compose file from.
template to build your own compose file.

Lastly, you can choose to run [docker](https://docs.docker.com/get-started/) directly. This mode is necessarily
more verbose but should you prefer to not use docker-compose it can also illustrate how to establish
a OpenZiti Network piece by piece.
an OpenZiti Network piece by piece.

## Prerequisites

### Bash

All of these quickstarts will use bash. On MacOS/linux this will be natural however on Windows you'll want
All of these quickstarts will use bash. On MacOS/Linux this will be natural however on Windows you'll want
to ensure you have a suitable shell. There are numerous shells available but perhaps the simplest will be
to use [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/install-win10). You
might also use git-bash, cygwin, or any other bash shell you fancy.
to use [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/install-win10). You
might also use git-bash, Cygwin, or any other bash shell you fancy.

### Docker/Docker Compose

Expand All @@ -51,40 +51,39 @@ The express install script will do quite a few things to get you bootstrapped.
1. create a full suite of PKI
1. create a config file for the controller
1. create a config file for an edge router
1. download the latest distribution of ziti from github.com/openziti/ziti/releases
1. download the latest distribution of Ziti from github.com/openziti/ziti/releases
1. unzip the distribution
1. start the `ziti-controller` and `ziti-router` executables
1. the `ziti-controller` should now be exposed on https://$(hostname):1280
1. start the controller and router in the background
1. expose the controller on https://$(hostname):1280

## Docker - Compose

The [docker-compose](https://docs.docker.com/compose/) based example will create numerous `ziti-router`s
The [docker-compose](https://docs.docker.com/compose/) based example will create numerous `ziti-router`s
as well as spooling up a `ziti-controller` and expose the controller on port 1280. This configuration is intended to
look and feel like the following image:
![image info](./docker-compose-nw.svg)

Here, a simple OpenZiti Network is shown which contains two public OpenZiti Edge Routers, one router without the "edge" enabled
and usable only for transit, and two private edge routers: one blue, one red. The goal with this setup is to attempt to
have a single isolated service that is not accessible from outside of the blue network (as best as possible with
have a single isolated service that is not accessible from outside of the blue network (as best as possible with
only docker).

## Docker - No Compose

You can still startup a dev environment easily with [docker](https://docs.docker.com/get-started/) only. In this example
you will start a OpenZiti Controller as well as a single OpenZiti Edge Router.
You can still start up a dev environment easily with [docker](https://docs.docker.com/get-started/) only. In this example,
you will start an OpenZiti Controller as well as a single OpenZiti Edge Router.

### Prerequisite

Since the openziti project is all about creating overlay networks - it's important for the docker containers to be
able to communicate to one another. This is accomplished using a docker network and setting the alias of the container
on that docker network.
The Docker containers must be able to communicate with one another. This is accomplished using a Docker network and
setting the alias of the container on that Docker network.

Before running the commands below please do the following:

#declare a variable that defines the 'network'
zitinw="myZitiNetwork"
#declare a fully qualified path to the location you want your shared files to go and create it
#declare a fully qualified path to the location that you want your shared files to go and create it
zitinw_shared="${HOME}/.ziti/dockerenvs/${zitinw}"
mkdir -p "${zitinw_shared}"

Expand Down

0 comments on commit d16ec86

Please sign in to comment.