Commit Graph

1495 Commits

Author SHA1 Message Date
cli-docs-updater a5cf9950e1 docs: Update generated CLI docs 2024-07-11 08:32:47 +00:00
Charlie Egan 9bd7b5a528 docs: Better link language SDKs (#6866)
The SDK support is there for many languages now and these
are likely a preferred way to use OPA's REST API for many
application developers.

This PR adds some links to make sure these are featured in
suitable locations so they are not missed as people browse
the docs.

Signed-off-by: Charlie Egan <charlie@styra.com>
2024-07-10 10:21:13 +01:00
cli-docs-updater b8a7809d99 docs: Update generated CLI docs 2024-07-02 13:11:57 +00:00
Sven Grosen e2721d3e01 Resurrect Workload Identity Work (#6802)
Add support for using Azure Workload Identity authentication.

Signed-off-by: Sven Grosen <svengrosen@gmail.com>
2024-07-01 20:02:06 +02:00
Charlie Egan 46b19707e7 docs: Use Example field for alternative commands (#6837)
* docs: Use Example field for alternative commands

This makes it safer to process this text into markdown and other
formats. (<path> is tricky as it looks like an HTML tag.

Signed-off-by: Charlie Egan <charlie@styra.com>

* docs: update CLI docs

Signed-off-by: Charlie Egan <charlie@styra.com>

---------

Signed-off-by: Charlie Egan <charlie@styra.com>
2024-07-01 10:36:39 +01:00
cli-docs-updater cb77956ed3 docs: Update generated CLI docs 2024-06-26 13:55:59 +00:00
cli-docs-updater 5647253da1 docs: Update generated CLI docs 2024-06-26 13:06:38 +00:00
Colin J Lacy 96800d747b cmd/exec: adds --stdin-input (-I) flag for input piping or manual entry (#6822)
Signed-off-by: Colin Lacy <colinjlacy@gmail.com>
2024-06-26 15:04:54 +02:00
Johan Fylling 96ecf38a90 trace+tester: Adding local var values to trace and test report (#6815)
Fixing: #2546
Signed-off-by: Johan Fylling <johan.dev@fylling.se>
2024-06-25 14:31:12 +02:00
dependabot[bot] 3b06458cd0 build(deps-dev): bump braces in /docs/website/scripts/live-blocks (#6820)
Bumps [braces](https://github.com/micromatch/braces) from 3.0.2 to 3.0.3.
- [Changelog](https://github.com/micromatch/braces/blob/master/CHANGELOG.md)
- [Commits](https://github.com/micromatch/braces/compare/3.0.2...3.0.3)

---
updated-dependencies:
- dependency-name: braces
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-06-19 14:07:25 +02:00
Charlie Egan 1b052e18a8 Add page aliases for moved or renamed pages. (#6821)
https://github.com/open-policy-agent/opa/pull/6811

In the above PR, some pages were moved or renamed. This adds some aliases to those pages so that redirects are handled by Hugo correctly.

Signed-off-by: Charlie Egan <charlie@styra.com>
2024-06-17 10:24:27 +01:00
Charlie Egan 612b93af1f docs: Revise language SDK content (#6811)
In the OPA ecosystem, there are a number of language SDKs for different
general purpose languages, mostly integrating with the REST API. This PR
highlights these at the start of the OPA ecosystem page, adds some other
projects for completeness and clarifies the owner where more than one
SDK for a language exists.

Signed-off-by: Charlie Egan <charlie@styra.com>
2024-06-11 13:34:03 +01:00
Anders Eknert 6212f30619 docs: mention that default functions may not evaluate (#6806)
Fixes #6265

Signed-off-by: Anders Eknert <anders@styra.com>
2024-06-11 08:25:46 +02:00
Charlie Egan 12d6e9f662 docs: add flipt blog to their ecosystem page (#6789)
Signed-off-by: Charlie Egan <charlie@styra.com>
Co-authored-by: Anders Eknert <anders@styra.com>
2024-06-04 15:24:18 +01:00
Charlie Egan 186f7bcab1 docs: add vs code and zed to ecosystem page (#6788)
Signed-off-by: Charlie Egan <charlie@styra.com>
2024-06-04 15:54:40 +02:00
Philip Conrad 8a9cfdd59d docs/content/monitoring: Remove missing prometheus metric go_memstats_gc_cpu_fraction
Prometheus appears to have dropped the `go_memstats_gc_cpu_fraction`
metric, since at least Go 1.18. This commit drops the missing metric
from the table of expected metrics for OPA on the monitoring docs page.

Reference: https://github.com/prometheus/client_golang/issues/1500

Fixes: #6783

Signed-off-by: Philip Conrad <philipaconrad@gmail.com>
2024-06-03 23:33:30 -07:00
Mark Phelps ce4df7825d Add Flipt to the OPA ecosystem (#6781)
Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
2024-06-02 20:29:36 +02:00
Rudrakh Panigrahi eeb633863b add http.send request attribute to ignore headers for caching key
Signed-off-by: Rudrakh Panigrahi <rudrakh97@gmail.com>
2024-05-30 09:37:34 -07:00
Anders Eknert 02c565a982 Add remainder operator to grammar (#6767)
Signed-off-by: Anders Eknert <anders@eknert.com>
2024-05-28 21:30:05 +02:00
Johan Fylling cb9d347738 Adding documentation for new IsSetStmt IR statement (#6764)
Signed-off-by: Johan Fylling <johan.dev@fylling.se>
2024-05-28 16:33:19 +02:00
Ashutosh Narkar a8ac7b38bb plugins/logs: Include http request context in decision logs
It would be useful if users had the ability to enhance the
decision log with info from the incoming HTTP request such as
headers. This change allows users to configure headers whose
values if present in the incoming HTTP request would be
surfaced via the decision log. This can be extended in the
future to include more context from the request.

Fixes: #6693

Signed-off-by: Ashutosh Narkar <anarkar4387@gmail.com>
2024-05-20 11:08:42 -07:00
Ashutosh Narkar 3aba58c217 docs: Update query API doc with details about overridding the def decision path
Signed-off-by: Ashutosh Narkar <anarkar4387@gmail.com>
2024-05-10 10:29:12 -07:00
Anders Eknert c867c30ed7 docs: Add arrays to composite values section
Rather simple, but I'm not sure we need more.

Fixes #6727

Signed-off-by: Anders Eknert <anders@eknert.com>
2024-05-06 09:25:08 -07:00
Aleksander e011f607d8 Use best practice package name in test examples (#6731)
Best practice according to https://docs.styra.com/regal/rules/testing/test-outside-test-package is to have tests in a package with _test suffix, but this is not documented anywhere.

Updating the examples is an easy way to teach readers the best practice

Signed-off-by: Aleksander <Aleksander.Sleire@Signicat.com>
2024-05-03 14:28:16 +02:00
Antonio B 7ec4d580f1 Fix dynamic metadata object in docs (#6709)
Signed-off-by: Antonio Berben <antonio.berben@solo.io>
2024-04-30 22:29:23 +02:00
johndbro1 f2011b1bb0 Adding Raygun to the policy-testing ecosystem (#6712)
Signed-off-by: John Brothers <johnbr@gmail.com>
2024-04-24 20:07:15 +02:00
Ashutosh Narkar 44fa8ad64b Relax configuration check when Discovery is enabled
Previously if Discovery was enabled, other features like bundle downloading and status reporting could not be configured manually.
The reason for this was to prevent OPAs being deployed that could not be controlled through discovery. It's possible that
the system serving the discovered config is unaware of all options locally available in OPA. Hence, we relax the configuration
check when discovery is enabled so that the bootstrap configuration can contain plugin configurations. In case of conflicts,
the bootstrap configuration for plugins wins. These local configuration overrides from the bootstrap configuration are included
in the Status API messages so that management systems can get visibility into the local overrides.

**In general, the bootstrap configuration overrides the discovered configuration.** Previously this was not the case for all
configuration fields. For example, if the discovered configuration changes the `labels` section, only labels that are
additional compared to the bootstrap configuration are used, all other changes are ignored. This implies labels in the
bootstrap configuration override those in the discovered configuration. But for fields such as `default_decision`, `default_authorization_decision`,
`nd_builtin_cache`, the discovered configuration would override the bootstrap configuration. Now the behavior is more consistent
for the entire configuration and helps to avoid accidental configuration errors.

Fixes: #5722

Signed-off-by: Ashutosh Narkar <anarkar4387@gmail.com>
2024-04-23 15:32:37 -07:00
Torin Sandall 93ff7191f1 docs/configuration: Tidy up headers in Services section (#6695)
Signed-off-by: Torin Sandall <torin@styra.com>
2024-04-13 04:58:26 +02:00
Johan Fylling 94724e612f docs: Updating OPA v1.0 docs
Documenting bundle rego-version.

Signed-off-by: Johan Fylling <johan.dev@fylling.se>
2024-04-11 10:36:05 -07:00
kunal.das ae636de8c0 fixes #6206; using cuboid rather than cube
Signed-off-by: kunal.das <kd.kunaldas92@gmail.com>
2024-04-10 09:10:56 -07:00
Sean Williams e0ee7418b0 topdown: Add json.marshal_with_options() builtin for indented/"pretty-printed" and/or line-prefixed JSON (#6636)
Fixes #6630

Signed-off-by: Sean Williams <72675818+sean-r-williams@users.noreply.github.com>
2024-04-05 10:11:01 +02:00
Charlie Egan 9a13941ab9 docs: Add Rego comparisons and update env0 (#6663)
These integrations feature on the learning rego page and the terraform
pages respectively.

Signed-off-by: Charlie Egan <charlie@styra.com>
2024-04-03 13:26:13 +01:00
Yariv Gavriel 8812c64270 add env0 integration & organization files (#6658)
Signed-off-by: yarivg <yarivgavriel2@gmail.com>
2024-04-03 12:18:52 +02:00
Charlie Egan b705d5b4ae docs: Clear up some uses of future keywords (#6653)
- link to the OPA v1.0 doc to add more context to the rego.v1 notes
- CONTINUED to use
  https://www.openpolicyagent.org/docs/latest/policy-language/#future-keywords
  as the source of truth for notes about future keywords.
- Removed some old style examples.

Signed-off-by: Charlie Egan <charlie@styra.com>
2024-03-28 14:21:55 +01:00
Anders Eknert a7d27ef1ff Add Rego v1 keywords (#6649)
Let me know if these should be in a box of their own — my reasoning
was that they should be avoided even prior to that, so if people won't
use them as var names or whatever, all the better.

Signed-off-by: Anders Eknert <anders@eknert.com>
2024-03-28 11:27:38 +01:00
Ashutosh Narkar d3a4a87f50 plugins/rest: Update service name while generating signature
The service name used for signing the request must be same as
the host header which is of the form https://sts.*

Signed-off-by: Ashutosh Narkar <anarkar4387@gmail.com>
2024-03-27 12:08:00 -07:00
Ashutosh Narkar 5f16f4a238 plugins/rest: Add support to get temp creds via AssumeRole
Adds support for signing AWS requests using temporary credentials
obtained from AWS STS via AssumeRole operation. One use-case of
this mechanism is for allowing existing IAM users to access AWS resources
that they don't already have access to. It is also useful as a means to
temporarily gain privileged access.

Signed-off-by: Ashutosh Narkar <anarkar4387@gmail.com>
2024-03-26 15:29:09 -07:00
0marq 6c08d3fa15 docs: Update delta bundle patch doc for remove op
Update remove description to mention that target path must exist.

Signed-off-by: 0marq <45561584+0marq@users.noreply.github.com>
2024-03-26 13:28:58 -07:00
occupyhabit d6c8c1b51b chore: remove repetitive words
Signed-off-by: occupyhabit <wangmengjiao@outlook.com>
2024-03-25 11:28:12 -07:00
Adam Setch fa5c72b36b docs: fix typo (#6637)
Signed-off-by: Adam Setch <adam.setch@outlook.com>
2024-03-18 20:59:22 +01:00
Philip Conrad 6b7ede0ee0 cmd/exec: Add timeout flag to help prevent infinite hangs. (#6633)
This commit adds a `--timeout` duration flag to the `opa exec` CLI command.
This flag helps out in use cases such as CI, where stalling indefinitely
is undesirable behavior.

Fixes: #6613

Signed-off-by: Philip Conrad <philipaconrad@gmail.com>
2024-03-18 12:22:41 -04:00
cli-docs-updater c779345458 docs: Update generated CLI docs 2024-03-15 10:01:22 +00:00
Peter Macdonald 1a1ff2bb53 Adding integration for Backstage (#6629)
Adding integration for Backstage

Signed-off-by: Peter Macdonald <macdonald.peter90@gmail.com>
2024-03-13 21:04:17 +01:00
Robbie 9b91c338fd Add Tunnelmole as an open source tunneling option in the Cloudformation hooks documentation (#6626)
Signed-off-by: Robbie <robbie-cahill@proton.me>
2024-03-12 12:08:25 +01:00
Prasanth Jayachandran 7f5e3a9d1e aws: support for Unsigned Payload or provided content sha256 in AWS signing (#6581)
To support uses cases where OPA is used for signing s3 requests whose payload is
not known upfront or payload is big enough (big file upload) to be sent over wire,
this PR adds support for unsigned payloads.

AWS signer has configurable option to use unsigned payload where the
x-amz-content-sha256 is set to "UNSIGNED-PAYLOAD" and is included as part
of signing process. This PR provides an option for unsigned payload if
aws_config.disable_payload_signing is set to true. If payload signing is
disabled, SignV4 method will not compute the content sha from the request body
but instead use "UNSIGNED-PAYLOAD" string literal for x-amz-content-sha256
header during signature computation.

References:
https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-header-based-auth.html
https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html
Signed-off-by: Prasanth Jayachandran <p_jayachandran@apple.com>
2024-03-08 10:57:51 -08:00
Anders Eknert 40bdc6125a Docs: mention homebrew install option
And replace AMD64 option with ARM64 as that's likely what most Macs
run with these days.

Fixes #6622

Signed-off-by: Anders Eknert <anders@styra.com>
2024-03-08 10:43:48 -08:00
Charlie Egan 79d2f53856 docs: fix broken schema link (#6617)
This link should point to #annotations on the same page.

Signed-off-by: Charlie Egan <charlie@styra.com>
2024-03-06 09:51:28 +00:00
Manfred Moser 8d6b930cb1 Add Trino to OPA ecosystem
Signed-off-by: Manfred Moser <manfred@simpligility.ca>
2024-02-29 09:23:05 -08:00
Ashutosh Narkar a34e591d28 docs: Udpate description of the url path usage for v1/data GET and POST (#6567)
This change updates the description of how the url path is used
to access values inside object and array documents. For data patch
operations, the description was updated to reflect the implementation.

Signed-off-by: Ashutosh Narkar <anarkar4387@gmail.com>
2024-02-03 07:34:43 +01:00
Anders Eknert daa2362ccd docs: use application/yaml instead of application/x-yaml (#6565)
This is a recognized content type now, so no need for the x prefix.

I also fixed some language in the doc while at it.

Signed-off-by: Anders Eknert <anders@eknert.com>
2024-02-01 15:14:56 +01:00