Skip to content

Commit

Permalink
V1.16.x delete internal api docs (#10373)
Browse files Browse the repository at this point in the history
  • Loading branch information
sheidkamp authored Nov 19, 2024
1 parent af18d2d commit 66ad08f
Show file tree
Hide file tree
Showing 115 changed files with 84 additions and 10,923 deletions.
11 changes: 11 additions & 0 deletions changelog/v1.16.23/remove-external-apis.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
changelog:
- type: FIX
issueLink: https://github.com/solo-io/solo-projects/issues/6768
resolvesIssue: false
description: >-
Remove docs for external APIs
- type: DEPENDENCY_BUMP
dependencyOwner: solo-io
dependencyRepo: solo-kit
dependencyTag: v0.34.4
issueLink: https://github.com/solo-io/solo-projects/issues/6768
5 changes: 0 additions & 5 deletions docs/build-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -265,11 +265,6 @@ firebaseJson=$(cat <<EOF
"destination": "/gloo-edge/:version/reference/api/github.com/solo-io/gloo/projects/gateway/api/v1/virtual_service.proto.sk/",
"type":"301"
},
{
"source": "/gloo-edge/:version/v1/github.com/solo-io/gloo/projects/gloo/api/v1/plugins/transformation/transformation.proto.sk/",
"destination": "/gloo-edge/:version/reference/api/github.com/solo-io/gloo/projects/gloo/api/external/envoy/extensions/transformation/transformation.proto.sk/",
"type":"301"
},
{
"source": "/gloo-edge/:version/v1/github.com/solo-io/gloo/projects/gloo/api/v1/proxy.proto.sk/",
"destination": "/gloo-edge/:version/reference/api/github.com/solo-io/gloo/projects/gloo/api/v1/proxy.proto.sk/",
Expand Down
2 changes: 1 addition & 1 deletion docs/content/guides/security/csrf/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -440,4 +440,4 @@ x-envoy-upstream-service-time: 2

In this guide, we described what is Cross Site Request Forgery (CSRF) and approaches for dealing with these attacks. We delved into one Gloo Edge approach that directly uses an integrated Envoy filter.

For more information, check out both the [Envoy docs](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/csrf_filter#config-http-filters-csrf) and [Gloo docs]({{% versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gloo/api/external/envoy/extensions/filters/http/csrf/v3/csrf.proto.sk/" %}}).
For more information, check out the [Envoy docs](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/csrf_filter#config-http-filters-csrf).
8 changes: 3 additions & 5 deletions docs/content/guides/security/waf/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,14 @@ You have several options for using ModSecurity to write WAF policies:
{{% /notice %}}
* Write your own custom rules by following the [ModSecurity rules language](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-(v3.x)). For examples, see [Configure WAF policies](#configure-waf-policies).

For more information, see the [Gloo API docs]({{% versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gloo/api/external/envoy/extensions/waf/waf.proto.sk/" %}}).

### Understand the WAF API {#about-api}

The WAF filter supports a list of `RuleSet` objects which are loaded into the ModSecurity library. The Gloo Edge API has a few conveniences built on top of that to allow easier access to the OWASP Core Rule Set (via the [`coreRuleSet`](#core-rule-set) field).

You can disable each rule set on a route independently of other rule sets. Rule sets are applied on top of each other in order. This order means that later rule sets overwrite any conflicting rules in previous rule sets. For more fine-grained control, you can add a custom `rule_str`, which is applied after any files of rule sets.

Review the following `RuleSet` API example and explanation. For more information, see the [Gloo API docs]({{% versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gloo/api/external/envoy/extensions/waf/waf.proto.sk/" %}}).
Review the following `RuleSet`

```proto
message ModSecurity {
Expand Down Expand Up @@ -432,7 +431,7 @@ of envoy's access logging. This means that directives that configure the audit e
This is **intentional** - to make sure that ModSecurity doesn't degrade
envoy performance. While the way we emit the logs is different, you have _all the features_ that
ModSecurity audit-logging provides:
- You can use the `action` property of the [audit logging configuration]({{% versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gloo/api/external/envoy/extensions/waf/waf.proto.sk/#auditlogging" %}}) instead of [SecAuditEngine](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#SecAuditEngine) to choose when to log.
- You can use the `action` property of the audit logging configuration instead of [SecAuditEngine](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#SecAuditEngine) to choose when to log.
- You can still use the [SecAuditLogParts](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#SecAuditLogParts),
[SecAuditLogRelevantStatus](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#SecAuditLogRelevantStatus) and (assuming action is RELEVANT_ONLY) `noauditlog` features of ModSecurity.
- The format of the log is controlled by [SecAuditLogFormat](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#SecAuditLogFormat).
Expand All @@ -454,8 +453,7 @@ is better for your specific use-case.
Let's see this in action!
To enable audit logging, edit the [auditLogging]({{% versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gloo/api/external/envoy/extensions/waf/waf.proto.sk/#auditlogging" %}}) field in your
[WAF settings]({{% versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gloo/api/v1/enterprise/options/waf/waf.proto.sk/#settings" %}}).
To enable audit logging, edit the auditLogging field in your WAF settings.
For example, lets edit our `VirtualService` with some
rules and audit logging:
Expand Down
2 changes: 1 addition & 1 deletion docs/content/guides/traffic_management/buffering/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ You can configure a maximum payload size on a gateway (`perConnectionBufferLimit

## Route

You can set buffer limits and other connection options with the [Buffer]({{< versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gloo/api/external/envoy/extensions/filters/http/buffer/v3/buffer.proto.sk/" >}}) settings in the options of a [Route]({{< versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gateway/api/v1/virtual_service.proto.sk/#route" >}}) in a [RouteTable]({{< versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gateway/api/v1/route_table.proto.sk/" >}}).
You can set buffer limits and other connection options with the Buffer settings in the options of a [Route]({{< versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gateway/api/v1/virtual_service.proto.sk/#route" >}}) in a [RouteTable]({{< versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gateway/api/v1/route_table.proto.sk/" >}}).

```yaml
apiVersion: gateway.solo.io/v1
Expand Down
2 changes: 0 additions & 2 deletions docs/content/installation/advanced_configuration/gzip.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ spec:

Once that is saved, you're all set. Traffic on the http gateway will call the gzip filter.

You can learn about the configuration options [here]({{< versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gloo/api/external/envoy/config/filter/http/gzip/v2/gzip.proto.sk" >}}).

More information about the Gzip filter can be found in the [relevant Envoy docs](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/gzip_filter). If data is not being compressed, you may want to check that all the necessary conditions for the Envoy filter are met.
See the [How it works](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/gzip_filter#how-it-works)
section for information on when compression will be skipped.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/introduction/traffic_filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Review the following diagram of how Gloo Edge filters traffic, depending on what
* **CORS**: See the [Cross-origin resources sharing security guide]({{% versioned_link_path fromRoot="/guides/security/cors/" %}}).
* **DLP**: See the [Data loss prevention security guide]({{% versioned_link_path fromRoot="/guides/security/data_loss_prevention/" %}}).
* **WAF**: See the [Web application firewall security guide]({{% versioned_link_path fromRoot="/guides/security/waf/" %}}).
* **Sanitize**: See the [sanitize proto reference]({{% versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gloo/api/external/envoy/extensions/extauth/sanitize.proto.sk/" %}}).
* **Sanitize**
4. **Filters only after external auth**: Review the information about other filters that you can apply only after external auth.
* **RBAC**: Note that the RBAC filter requires the `JwtStaged` filter. See the [RBAC proto reference]({{% versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gloo/api/v1/enterprise/options/rbac/rbac.proto.sk/" %}}).
* **gRPC-web**: See the [gRPC web guide]({{% versioned_link_path fromRoot="/guides/traffic_management/listener_configuration/grpc_web/" %}}).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,6 @@ In the previous example, `Upstream` pings are issued every 2 seconds. You might
```
{{< /highlight >}}
For more information, see the [health check API documentation]({{% versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gloo/api/external/envoy/api/v2/core/health_check.proto.sk/#healthcheck" %}}).
[Retries]({{% versioned_link_path fromRoot="/guides/traffic_management/request_processing/retries/" %}}) are configured on `VirtualServices` at the route level:
{{< highlight yaml "hl_lines=17" >}}
Expand Down
2 changes: 1 addition & 1 deletion docs/content/operations/production_deployment/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ Also, consider using `retries` on your _routes_. The default value for this attr

### Proxy latency filter

In the `httpGateway.options` section of your Gateway resource, you can enable the proxy latency filter. This Envoy filter measures the request and response latency incurred by the filter chain in additional histograms and access log parameters. For more information about the `proxyLatency` section, see the [API reference]({{% versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gloo/api/external/envoy/extensions/proxylatency/proxylatency.proto.sk/#proxylatency" %}}).
In the `httpGateway.options` section of your Gateway resource, you can enable the proxy latency filter. This Envoy filter measures the request and response latency incurred by the filter chain in additional histograms and access log parameters.

### Grafana dashboards

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

This file was deleted.

Loading

0 comments on commit 66ad08f

Please sign in to comment.