Get Started¶

Pick what you want to do. Each section points to the page to start from.

Understand the platform¶

The Architecture overview shows what OpenOP is made of and what each component does.

Try it on your own machine¶

The Quickstart runs the whole platform on your computer in about 10 minutes, with login turned off. It is the quickest way to look around the Portal and the APIs.

Learn to use it¶

The Tutorials take you through the platform one task at a time: getting API access, deploying an application, using network capabilities, AI², the Data Lab and federation.

Deploy it¶

• Deploy with Helm installs one platform, on a local kind cluster or on your own Kubernetes cluster.
• Deploy with Ansible installs one platform per operator and can connect them through federation.

After installing, define your edge zones and manage users and access.

Keep it running¶

Troubleshooting helps you follow a failed request through the components. Run the end-to-end tests builds a throwaway platform, tests it and removes it again.

Connect your own infrastructure¶

Integrations lists the edge and network backends that Release 2 supports, and shows how to write an adapter for a new one.

Contribute¶

Contributing explains how to report issues and contribute code or documentation.