Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a README for starting up the reflect example project #232

Closed
wants to merge 2 commits into from

Conversation

gberl002
Copy link
Contributor

No description provided.

@gberl002 gberl002 requested a review from a team as a code owner March 18, 2022 18:18

To run express install, check out the instructions [here](https://openziti.github.io/ziti/quickstarts/network/local-no-docker.html)

If running express install, you will need to add the ziti binaries to your path which you can do with the following command.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's remove these bits about putting it on the path. Let people figure out how to run the file.

### Create A Ziti Network
You will need to have ziti executables available to run from your command line. If you do not have them, the easiest way to set yourself up is to run ziti express install.

To run express install, check out the instructions [here](https://openziti.github.io/ziti/quickstarts/network/local-no-docker.html)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say: "run one of the quickstarts found at the landing page" and just send them to openziti.github.io

#### Start The Network Devices
Start up your controller (which is automatically set up by the express install).

* If you used the express install then simply run `startZitiController`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just say that a running ziti environment is a prereq, keep any starting of the controller out of here to avoid confusion

* If you used the express install then simply run `startExpressEdgeRouter`
* Otherwise, the command would be as follows
```
ziti-router run "path-to-edge-router-config.yaml"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as before, same with "log into the controller"


## Setup

Before continuing, it is recommended that you `cd` into the example project directory.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"why" would i want or need to? I'd argue it doesn't much matter?

ziti edge create service reflect_svc
```

### Update The Service Policy
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Update" should be "Create"

### Update The Service Policy
The service policy needs to be updated to handle traffic between the client and the server.

To update the service policy, run the following:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update->create and "service policies" since there's two here

./main server -i server.json -s reflect_svc
```

In a new bash window, start up the client:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

technically this could be zsh or sh or even cmd/powershell so just leave out the "bash" bit

@gberl002
Copy link
Contributor Author

README doc was generated by another dev, closing this PR as it's no longer needed.

@gberl002 gberl002 closed this Oct 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants