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

dan/per-10200-write-docs-on-how-to-use-opal #612

Merged
merged 9 commits into from
Jul 16, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
37 changes: 37 additions & 0 deletions documentation/docs/opal-plus/deploy.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
sidebar_position: 2
title: Deploy OPAL+
---

With OPAL+, you get access to private Docker images that include additional features and capabilities.
obsd marked this conversation as resolved.
Show resolved Hide resolved
To apply for Permit OPAL+, [fill in the form available here](https://hello.permit.io/opal-plus)

In order to access the OPAL+ Docker images, you need to have Docker Hub credentials with an access token.
Those should be received from your Customer Success manager.
Reach out to us on Slack or via email if you need assistance.

[//]: # (TODO - add link to Slack and email address)

## Accessing the OPAL+ Docker Images

To access the OPAL+ Docker images, you need to log in to Docker Hub with your credentials.
You can do this by running the [docker login](https://docs.docker.com/reference/cli/docker/login/) command:

```bash
docker login -u <username> -p <password>
```

If you are using Kubernetes, check out the [Kubernetes documentation](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/) on how to pull images from a private registry.

After logging in, you can pull the OPAL+ Docker images using the following commands:

```bash
docker pull permitio/opal-plus:latest
```

## Running the OPAL+ Docker Images

Running the OPAL+ Docker images is similar to running the open-source OPAL images.

Check out the [OPAL Docker documentation](/getting-started/running-opal/run-docker-containers) for more information.

12 changes: 12 additions & 0 deletions documentation/docs/opal-plus/features.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
sidebar_position: 3
title: Advanced Features
---

OPAL+ has a number of advanced features extending the capabilities of the open-source OPAL.
These features are available to OPAL+ users only.


:::info
Coming soon.
:::
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
sidebar_position: 1
title: Permit OPAL+ (Extended OPAL License)
title: Introduction
---


<div
style={{
display: "flex",
Expand Down Expand Up @@ -36,11 +37,13 @@ The package can include:
- Professional services for OPAL
- [Custom data-fetcher providers](tutorials/write_your_own_fetch_provider), including NRE.

## Who Can Get Access to OPAL+

The OPAL+ program is available for select enterprises, who apply for access;
Currently the program can accept up to 5 enterprises. Applications are reviewed and considered on a first come first served basis.
## Joining the OPAL+ Program

## How to Apply to OPAL+
The OPAL+ program is available for select enterprises, who apply for access;
Currently the program can accept up to 5 enterprises. Applications are reviewed and considered on a first-come-first-served basis.

To apply for Permit OPAL+, [fill in the form available here](https://hello.permit.io/opal-plus)



41 changes: 41 additions & 0 deletions documentation/docs/opal-plus/troubleshooting.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
sidebar_position: 10
title: Troubleshooting
---

When something goes wrong, we are here to help.

Feel free to reach out to us on Slack on our [community channel](https://bit.ly/opal-slack)
or in your dedicated OPAL+ support channel, and we will do our best to assist you quickly.

### Seeking Support

If you are experiencing issues with OPAL+, please provide us with the following information:

#### Extract Logs

On production, we advise you to connect OPAL+ to your logging system to collect logs.
Configure the [LOG_SERIALIZE](/getting-started/configuration) environment variable to `true` to serialize logs in JSON format.

When running OPAL+ locally or in a development environment, you can extract logs from the console.
Alternatively, you can enable logging to file by setting the [LOG_TO_FILE](/getting-started/configuration) to `true`.

You can also enable debug logs by setting the [LOG_LEVEL](/getting-started/configuration) environment variable to `debug`.

#### Export Configuration

You can export your configuration by running the following command:

```bash
opal-client print-config
```

Make sure to censor any sensitive information, like passwords or API keys, before sharing the configuration.

## Common Issues

More common issues and their solutions are available in the [OPAL documentation](/getting-started/running-opal/troubleshooting).

:::note
danyi1212 marked this conversation as resolved.
Show resolved Hide resolved
This part is a work in progress, and we will be adding more content soon.
:::
4 changes: 2 additions & 2 deletions documentation/docs/release-updates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ us and asking for additional capabilities on top of those provided by OPAL.

If you just need a hosted version of OPAL; or you're building application-level permissions consider simply using [Permit.io's PRO tier](https://www.permit.io/pricing).

Read more about **[OPAL+ here](/OPAL_PLUS)**.
Read more about **[OPAL+ here](/opal-plus/introduction)**.
:::

---
Expand Down Expand Up @@ -65,7 +65,7 @@ request is an 401, no secret was provided. This is unexpected as the configurati
4. Bump `http-cache-semantics` from `4.1.0` to `4.1.1` in `/documentation`
5. Bump `eta`, `@docusaurus/core` and `@docusaurus/preset-classic` in `/documentation`
6. Bump `@sideway/formula` from `3.0.0` to `3.0.1` in `/documentation`
7. Addition of **[OPAL-plus](/OPAL_PLUS)**
7. Addition of **[OPAL-plus](/opal-plus/introduction)**

---

Expand Down
16 changes: 11 additions & 5 deletions documentation/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -283,14 +283,20 @@ const sidebars = {
label: "Fetch Providers",
},
{
type: "doc",
id: "FAQ",
label: "FAQ",
type: "category",
label: "💎 OPAL+ (Extended License)",
collapsed: true,
items: [
{
type: "autogenerated",
dirName: "opal-plus",
},
],
},
{
type: "doc",
id: "OPAL_PLUS",
label: "OPAL + (Extended OPAL License)",
id: "FAQ",
label: "FAQ",
},
],
};
Expand Down
Loading