Commit Graph

25 Commits

Author SHA1 Message Date
Torin Sandall 54827f3ef4 docs/content: Update docs to use := at the file-level
This partially addresses #4599.

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2022-04-20 09:27:39 -07:00
Peter Helewski d98015270e fixing broken links in the online documentation (#4224)
Signed-off-by: Peter Helewski <phelewski@gmail.com>
2022-01-14 15:54:29 +01:00
Johan Fylling 7b642700b4 topdown+wasm: Verifying host based on allow_net allowlist in built-in functions (#4152)
Adding host allow-listing based on the allow_net capability in the http.send()- and
net.lookup_ip_addr() built-in functions when running the eval command.

Fixes: #3665

Signed-off-by: Johan Fylling <johan.dev@fylling.se>
2021-12-17 19:43:02 +01:00
Stephan Renatus 28566664cf website/deployments/capabilities: mention Wasm ABI and future keywords
Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>
2021-11-02 15:49:53 -07:00
Torin Sandall 2ff024c390 Revert "Merge branch 'main' into main"
This reverts commit d0a6f964c8, reversing
changes made to b5e7139a11.

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2021-10-04 11:51:20 -07:00
Peter ONeill d0a6f964c8 Merge branch 'main' into main 2021-10-04 18:43:56 +02:00
Peter ONeill 5acbfc9bcc docs/deployments: add capabilities section (#3839)
Adding in instructions to the OPA docs on how to use capabilities feature.

Fixes: #3769

Signed-off-by: Peter ONeill <peteroneilljr@gmail.com>
2021-10-04 13:18:40 +02:00
Peter ONeill ad998adec3 Add capabilities section (#1)
* Add capabilities section

* Add example of capability struct
2021-09-30 11:41:02 +02:00
Anders Eknert 44de60a387 Restructure management docs one sub-page per topic
Signed-off-by: Anders Eknert <anders@eknert.com>
2021-04-26 17:14:41 +02:00
Torin Sandall ad1001a6df docs/content: Update references to default branch
Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2021-04-15 15:32:15 -04:00
Tim Hinrichs 162c3524b5 docs: Add discussion of bootstrapping and fail-open/fail-closed
Fixes #1699

Signed-off-by: Tim Hinrichs <tim@styra.com>
2020-06-26 11:09:38 -04:00
Torin Sandall 5fd5349f13 docs: Add guidance around resource utilization
There are many ways this question can be answered so this is not a
final answer but instead a starting point. In the future we can expand
on this section to include more use-case specific resource utilization
guidance however for the time being this is a good start.

Fixes #1601

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2020-04-17 07:32:04 -04:00
Naoki Oketani 12ff9c0a66 Migrate apiVersion to support k8s 1.16+
Fixes #1977

Signed-off-by: Naoki Oketani <okepy.naoki@gmail.com>
2020-01-31 18:49:02 -08:00
Patrick East 249ce31ad1 docs: Add note about edge docker image tag
We have info for the `latest` tag, `*-dev` tags, and this just adds
a blurb about the `edge` tag.

Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-09-13 19:44:54 -04:00
Torin Sandall b107ef2618 docs: Reorganize operations pages
* Move the integration guide into the core docs. This is one of the
  most common questions when people get started.
* Split the configuration and monitoring sections into their own
  pages. This prepares the management page for an introduction that
  explains the control plane concept.
* Move bundle section up to the top of the page since basic policy
  distribution is usually the first concern.

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2019-09-12 17:12:10 -04:00
Patrick East e8f652c436 docs: Fix all broken links
Any links that were caught by the link checker have been
repaired. This also standardizes some to ensure we are
always using URLs with trailing `/` when possible.

Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-09-10 09:58:50 -07:00
Tim Hinrichs 6760303a47 docs: Reorganize the docs navigation
The docs have grown organically and it was time for a reorganization, specifically
helping people understand at a single glance the information
that is available in the docs.

The new docs are organized as follows:
- Core docs (policy and data)
- Use-case specific docs
- Operations
- Support

As part of the reorganization, several files were renamed and/or combined.

Also made an editing pass over what was previously the user-attribute docs
and generalized them to focus on data-replication, an issue that is
now promoted to the core docs.  As part of that, updated the images
and removed the old ones; new image sources are in google slides.

Tweaked the navigation bar to give more space on the left-hand column
so that more of the topics are visible without scrolling.

Signed-off-by: Tim Hinrichs <tim@styra.com>
2019-08-29 09:29:08 -07:00
Torin Sandall 74d67c5de1 docs: Update to use live blocks
These changes update most of the docs to use live blocks. The
following pages have not been touched or updated significantly:

* Get Started - this page is based entirely on the REPL. We should
  revisit the "Get Started" page once these changes have
  landed. The existing page can live on as an introduction to the REPL
  while the Get Started page can be tailored to live blocks.

* Ceph Authorization - this page has not been updated aside from
  making the policy example use the live blocks for syntax
  highlighting. We need to revisit the policy example and refactor the
  tutorial a bit to emphasize the policy as opposed to the manifests
  required to install.

* Terraform - this page has not been touched because @vgramer is
  planning to update for Terraform v0.12. We can update this page once
  those changes are in to avoid conflicts.

These changes also remove the use of non-Markdown code examples. All
the examples are inlined into Markdown now.

A few OPA deployment examples have been updated to enable the console
decision logging. This is better than the request/response debug logs.

Fixes #1650

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2019-08-23 16:50:32 -04:00
Patrick East 0ed56fef03 Change to using custom text log formatter
This is less sophisticated than the default logrus one, but it is
much easier to read the server output. Primarily with JSON fields
and multi-line strings. They are decoded and prettified.

Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-05-10 12:04:56 -07:00
Patrick East 9be5e7b945 Make json logs the default and add json-pretty
The `json-pretty` log format flips on the “pretty” flag for logrus
which gives multi-line formatted json log output.

This also changes to make the `json` format to be the default as it
is likely to be what deployers want when running with `—server`.

Fixes: #1202
Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-05-10 12:04:56 -07:00
Torin Sandall 459a1b3699 docs: Add note about HTTP_PROXY and friends
Fixes #1410

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2019-05-07 10:08:45 -07:00
Patrick East 589105aff5 Add param to include bundle activation in /health response
There is a new parameter for /health REST API which will include the
Configured bundle activation in the response. Example:

GET /health?bundle=true HTTP/1.1

Without the parameter the behavior stays the same, with it the server
will respond with 500’s until the status has been updated with an
activation time.

The docs for kubernetes ready probe has been updated to show this as
it makes for a better ready check than the original behavior when
remote bundles are being used.

Fixes: #1153
Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-05-02 15:28:12 -06:00
Torin Sandall d75271818b docs: Reformat the cheatsheet and move next to reference
Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2019-04-30 13:34:54 -07:00
Patrick East f5953ce902 Fix extra ‘v’ in older versions of the docs
The older markdown still had `v{{< version >}}` shortcodes being used
which broke when the version changed to include the “v” in it.

This adds in some backwards compatibility logic for the shortcode and
adds newer, more specific, ones to replace it going forward. Part of
The issue is that typically the documentation will only want to
Reference the version that it is documenting and not always the
latest.

Fixes: #1382
Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-04-27 20:11:35 -07:00
Patrick East 230fae190d Move code snippets into docs content and version them
Previously the code content was only kept in master and was
Subsequently referenced by the versioned doc contents. This causes
A few problems.. so we will version it along with the doc content.

To get this to work we make a handful of changes:

* Move the docs up into just opa/docs/content/*, we’re going to remove
  The difference between local/dev and production builds soon.
* Move the “code” directory into the content dir, it is content tied
  To the markdown files already there.
* Change the Hugo config to ignore the code directories
* Change the “code” shortcode to load the versioned code snippet
* Change load-docs to copy the code directory in addition to the other
  markdown content.

Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-04-26 17:12:15 -07:00