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

Before big merge #692

Closed
wants to merge 26 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
_site
.vscode
.docusaurus/
/node_modules/*


# ignores for content generated before the doc site
Expand All @@ -19,4 +20,4 @@ github_deploy_key
sessions

# use yarn, not npm, see README.md for details
package-lock.json
package-lock.json
Empty file modified check-links/markdown-absolute-file-links.bash
100755 → 100644
Empty file.
17 changes: 17 additions & 0 deletions docusaurus/docs/learn/quickstarts/network/_b.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
This page will show you how to get your ff up and running
quickly and easily, entirely locally. Since you'll be running everything locally, you'll have no issues communicating
between network components. All the processes will run locally, and you'll be responsible for starting and stopping them
when you want to turn the overlay network on or off.

## Prerequisites

:::note
Make sure you have `tar`, `hostname`, `jq` and `curl` installed before running the `expressInstall` one-liner.
:::

There is not much preparation necessary to getting up-and-running locally. At this time, this guide expects that
you'll be running commands within a `bash` shell. If you're running Windows, you will need to make sure you have
Windows Subsystem for Linux installed for now. We plan to provide a Powershell script in the future, but for now the
script requires you to be able to use `bash`. Make sure your local ports 1280, 6262, 10000 are free before running the
controller. These ports are the default ports used by the controller. Also ensure ports 10080 and 3022 are open as these
are the default ports the edge router will use.
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Run `expressInstall` One-liner

Running the latest version of Ziti locally is as simple as running this one command:

```bash
source /dev/stdin <<< "$(wget -qO- https://get.openziti.io/quick/ziti-cli-functions.sh)"; expressInstall
```

This script will perform an 'express' install of Ziti which does the following:

* download the latest version of the OpenZiti binary (`ziti`)
* extract the binary into a predefined location: ~/.ziti/quickstart/$(hostname -s)
* create a full PKI for you to explore
* create a controller configuration using default values and the PKI created above
* create an edge-router configuration using default values and the PKI created above
* add helper functions and environment variables to your shell (explore the script to see all)

## Start the Components

Once the latest version of Ziti has been downloaded and added to your path, it's time to start your controller and
edge-router.
4 changes: 4 additions & 0 deletions docusaurus/docs/learn/quickstarts/network/hosted.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 60
---
import Wizardly from '@site/src/components/Wizardly';

# Host OpenZiti Anywhere

Expand Down Expand Up @@ -188,3 +189,6 @@ $ echo $ZITI_HOME
- Help
- [Change Admin Password](./help/change-admin-password.md)
- [Reset the Quickstart](./help/reset-quickstart.md)


<Wizardly></Wizardly>
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
sidebar_position: 50
---

import Wizardly from '@site/src/components/Wizardly';

# Local - Docker Compose

If you are not familiar with it, [Docker Compose](https://docs.docker.com/compose/) is a tool for defining and running
Expand Down Expand Up @@ -360,3 +363,5 @@ Hello World
- Help
- [Change Admin Password](./help/change-admin-password.md)
- [Reset the Quickstart](./help/reset-quickstart.md)

<Wizardly></Wizardly>
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ sidebar_label: Kubernetes
title: Kubernetes Quickstart
---

import Wizardly from '@site/src/components/Wizardly';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

`minikube` quickly sets up a local Kubernetes cluster on macOS, Linux, or Windows (WSL). This quickstart is a great way to explore running your own OpenZiti Controller, Router, and Console.

## Tools of the Trade

We'll use the preferred `minikube` Docker driver for this quickstart. You can run `minikube` in WSL with Docker Engine or Docker Desktop, but keep an eye out for one extra step to run `minikube tunnel` at the necessary point in the process.
Expand Down Expand Up @@ -624,3 +624,5 @@ Now that you've successfully tested the OpenZiti Service, check out the various
```

2. In your OpenZiti Tunneler, "Forget" your Identity.

<Wizardly></Wizardly>
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
sidebar_position: 30
---

import Wizardly from '@site/src/components/Wizardly';

# Local - No Docker

This page will show you how to get your [Ziti Network](/learn/introduction/index.mdx) up and running
Expand Down Expand Up @@ -197,3 +200,5 @@ source $HOME/.ziti/quickstart/$(hostname)/$(hostname).env
- Help
- [Change Admin Password](./help/change-admin-password.md)
- [Reset the Quickstart](./help/reset-quickstart.md)

<Wizardly></Wizardly>
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 40
---
import Wizardly from '@site/src/components/Wizardly';

# Local - With Docker

[Docker](https://www.docker.com) is a popular container engine, and many developers enjoy using solutions delivered via
Expand Down Expand Up @@ -199,3 +201,5 @@ results: 1-1 of 1
- Help
- [Change Admin Password](./help/change-admin-password.md)
- [Reset the Quickstart](./help/reset-quickstart.md)

<Wizardly></Wizardly>
94 changes: 47 additions & 47 deletions docusaurus/docs/learn/quickstarts/quickstarts.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,47 @@
---
sidebar_position: 3
id: quickstartOverview
---
# Start Cooking With Ziti
Learn how to start integrating Zero Trust directly into your application! Explore our quickstarts and learn how to
get your own open source zero trust network overlay setup.
OpenZiti is bringing Zero Trust to networks all over the world! To really get the most out of Ziti, you'll want to embed
it **directly** into your applications. Ziti provides numerous SDKs for this very purpose. If you're not ready to embed
Zero Trust right into your application you can still get started by using one or more of the
[tunneling apps](/learn/core-concepts/clients/choose.mdx).
:::note
If you get stuck on anything at all, remember that the link to the discourse sites is on the top right of all the doc
pages. Don't be afraid to ask the community for help!
:::
## Getting Started - Network
When you're just getting started, the first thing you will need is access to a
[Ziti Network](/learn/introduction/index.mdx). For someone just starting out, there are four basic options:
### Run all the binaries locally
Here you'll start and stop components on your own. This is great for learning but since it's all local, keeping any
services you define actually separate from your local machine is a bit hard.
### Run locally using [Docker](https://www.docker.com)
This allows you to do some more complex things like actually isolate services from even yourself.
### Run on your own server
This option is great for two situations. If you have a server This is great if you have other people you want to have
access to your [Ziti Network](/learn/introduction/index.mdx) and aren't on the local network.
* If you would prefer not to deal with setting up the [Ziti Network](/learn/introduction/index.mdx) you
* can sign up for a free-tier account over at the [NetFoundry Console](https://nfconsole.io/signup)
## Which network option sounds right for you?
* [Run Everything Locally - no Docker](./network/local-no-docker.md)
* [Run Everything Locally - using Docker](./network/local-with-docker.md)
* [Run Everything Locally - Docker Compose](./network/local-docker-compose.md)
* [Run Everything Hosted](./network/hosted.md)
---
sidebar_position: 3
id: quickstartOverview
---
# Start Cooking With Ziti

Learn how to start integrating Zero Trust directly into your application! Explore our quickstarts and learn how to
get your own open source zero trust network overlay setup.

OpenZiti is bringing Zero Trust to networks all over the world! To really get the most out of Ziti, you'll want to embed
it **directly** into your applications. Ziti provides numerous SDKs for this very purpose. If you're not ready to embed
Zero Trust right into your application you can still get started by using one or more of the
[tunneling apps](/learn/core-concepts/clients/choose.mdx).

:::note
If you get stuck on anything at all, remember that the link to the discourse sites is on the top right of all the doc
pages. Don't be afraid to ask the community for help!
:::

## Getting Started - Network

When you're just getting started, the first thing you will need is access to a
[Ziti Network](/learn/introduction/index.mdx). For someone just starting out, there are four basic options:

### Run all the binaries locally

Here you'll start and stop components on your own. This is great for learning but since it's all local, keeping any
services you define actually separate from your local machine is a bit hard.

### Run locally using [Docker](https://www.docker.com)

This allows you to do some more complex things like actually isolate services from even yourself.

### Run on your own server

This option is great for two situations. If you have a server This is great if you have other people you want to have
access to your [Ziti Network](/learn/introduction/index.mdx) and aren't on the local network.

* If you would prefer not to deal with setting up the [Ziti Network](/learn/introduction/index.mdx) you
* can sign up for a free-tier account over at the [NetFoundry Console](https://nfconsole.io/signup)

## Which network option sounds right for you?

* [Run Everything Locally - no Docker](./network/local-no-docker.md)
* [Run Everything Locally - using Docker](./network/local-with-docker.md)
* [Run Everything Locally - Docker Compose](./network/local-docker-compose.md)
* [Run Everything Hosted](./network/hosted.md)
2 changes: 1 addition & 1 deletion docusaurus/docs/learn/quickstarts/services/ztha.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ Hello World

### Ziti Admin Console (ZAC)

Optionally, you may [install the ZAC](/learn/quickstarts/zac/index.md) to manage your network with a UI.
Optionally, you may [install the ZAC](../zac/index.md) to manage your network with a UI.

### Testing Everything Works

Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/learn/quickstarts/zac/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Ziti Admin Console
---

import Wizardly from '@site/src/components/Wizardly';

The Ziti Administration Console (ZAC) is a web UI provided by the OpenZiti project which will allow you to configure and
explore a [Ziti Network](/learn/introduction/index.mdx).

Expand Down Expand Up @@ -186,3 +188,5 @@ There's [a Helm chart for deploying the Ziti console in Kubernetes](/docs/guides
![host it anywhere](./zac_configure_hia.png)

3. Optionally, [**change admin's password**](/learn/quickstarts/network/help/change-admin-password.md#ziti-console)

<Wizardly></Wizardly>
47 changes: 47 additions & 0 deletions docusaurus/docs/reference/test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
If you are not familiar with it, Docker Compose is a tool for defining and running multi-container Docker applications. It makes deploying multiple containers easy by using a declarative format defined via yaml. Note that this page uses "Compose V2". This means all the commands shown will reference docker compose, not docker-compose. If you're using the older style of compose, consider upgrading to the newer v2.

**Preparation - Required Files**

First, grab the compose file from the ziti repository.

Using curl that would look like this:

```
curl -so docker-compose.yaml https://get.openziti.io/dock/docker-compose.yml
Next, grab the default environment file or just make a file in this folder that looks like this:
```

```
curl -so .env https://get.openziti.io/dock/.env
```

or, if you would prefer to make your .env file manually, create a file in some way such as using the command shown below:

```
cat > .env DEFAULT_ENV_FILE
# OpenZiti Variables
ZITI_IMAGE=openziti/quickstart
ZITI_VERSION=latest
ZITI_CTRL_EDGE_ADVERTISED_ADDRESS=ziti-edge-controller

## Additional variables to override.
#ZITI_CTRL_EDGE_ADVERTISED_ADDRESS=some.other.name.com
#ZITI_CTRL_EDGE_ADVERTISED_PORT=1280
#ZITI_EDGE_CONTROLLER_IP_OVERRIDE=20.20.20.20
DEFAULT_ENV_FILE>
```

**CAUTION:** If you are running Void linux, you need to modify the docker-compose file, otherwise the services will not start properly. To do this, add the following two lines to each service definition.

```
security_opt:
- seccomp:unconfined
```

:::code-output

testing

:::

Please see this discussion for more information
12 changes: 8 additions & 4 deletions docusaurus/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -194,15 +194,19 @@ const config = {
presets: [
[
'classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
{
docs: {
sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/openziti/ziti-doc/tree/main/docusaurus',

/*
admonitions: {
keywords: ['code-output'],
extendDefaults: true,
},
*/
},
// blog: false,
blog: {
Expand All @@ -218,7 +222,7 @@ const config = {
trackingID: 'G-THVRRJ3GLE',
anonymizeIP: true,
},
}),
},
],
// Redocusaurus config
[
Expand Down
5 changes: 5 additions & 0 deletions docusaurus/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,24 @@
"@mdx-js/react": "^1.6.22",
"clsx": "^1.2.1",
"docusaurus-plugin-remote-content": "^3.1.0",
"jquery": "^3.7.1",
"mdx-mermaid": "^1.3.2",
"mermaid": "^9.4.3",
"node": "^20.5.0",
"octokit": "^2.0.7",
"prism-react-renderer": "^1.3.5",
"raw-loader": "^4.0.2",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"react-github-btn": "^1.4.0",
"react-markdown": "^8.0.7",
"react-player": "^2.12.0",
"react-render-markup": "^3.6.1",
"redocusaurus": "^1.4.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^2.4.1",
"json-loader": "^0.5.7",
"remark-code-import": "^1.1.1"
},
"browserslist": {
Expand Down
Loading