Skip to content

Commit

Permalink
Doc fixes 1.14 (#9592)
Browse files Browse the repository at this point in the history
* reword from revew in https://github.com/solo-io/gloo/pull/9566\#discussion_r1624903918

* update link

* fix rate limit section

* backport

---------

Co-authored-by: Art Berger <art.berger@solo.io>
Co-authored-by: Nadine Spies <nadine.spies@solo.io>
  • Loading branch information
3 people authored Jun 7, 2024
1 parent 07a305b commit 5c1da87
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 4 deletions.
5 changes: 5 additions & 0 deletions changelog/v1.14.31/docs-backports1.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
changelog:
- type: NON_USER_FACING
description: >-
Backports weekly docs, including fixes such as customer requests, links, typos, etc.
skipCI-kube-tests:true
2 changes: 1 addition & 1 deletion docs/content/guides/security/access_logging/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ $ kubectl logs -n gloo-system deploy/gateway-proxy
[2020-03-17T18:49:55.191Z] "GET /sample-route-1 HTTP/1.1" 200 - 0 86 1 1 "-" "curl/7.54.0" "4a0013d3-f0e6-44b8-ad5f-fa181852e6cd" "35.196.131.38" "10.52.0.54:8080"
```

For more details about the Envoy string format, check out the [envoy docs](https://www.envoyproxy.io/docs/envoy/v1.10.0/configuration/access_log#config-access-log-format-strings).
For more details about the Envoy string format, check out the [envoy docs](https://www.envoyproxy.io/docs/envoy/v1.30.2/configuration/observability/access_log/usage#format-strings).

### Outputting structured json

Expand Down
6 changes: 4 additions & 2 deletions docs/content/guides/security/rate_limiting/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,8 @@ You can configure descriptors in the Gloo Edge Settings for the entire cluster.
{{% tab name="All routes in the virtual host" %}}
```yaml
cat > vs-host-patch.yaml - <<EOF
spec:
virtualHost:
options:
ratelimit:
rateLimits:
Expand All @@ -192,12 +194,12 @@ EOF
{{< tabs >}}
{{% tab name="All routes in the virtual host" %}}
```sh
kubectl patch -n gloo-system vs default --type merge --patch "$(cat > vs-host-patch.yaml)"
kubectl patch -n gloo-system vs default --type merge --patch "$(cat vs-host-patch.yaml)"
```
{{% /tab %}}
{{% tab name="Per route" %}}
```sh
kubectl patch -n gloo-system vs default --type merge --patch "$(cat > vs-route-patch.yaml)"
kubectl patch -n gloo-system vs default --type merge --patch "$(cat vs-route-patch.yaml)"
```
{{% /tab %}}
{{< /tabs >}}
Expand Down
2 changes: 1 addition & 1 deletion docs/content/introduction/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This page covers some of the high-level questions commonly asked in community me

## Questions about Gloo Edge as a product {#product}

Gloo Edge is an API Gateway built on top of [Envoy Proxy](https://envoyproxy.io) that comes with a simple yet powerful control plane for managing Envoy as an edge ingress, API Gateway, or service proxy. Gloo Edge's control plane is built on a plugin model that enables extension and customization depending on your environment and comes with an out of the box Discovery plugin that can discover services running VMs, registered in Consul, running in Kubernetes, or deployed on a public cloud including Functions running in a Cloud Functions environment. The Envoy community moves fast and no two operational environments are identical, so we built Gloo Edge with this flexibility in mind.
Gloo Edge is an API Gateway built on top of [Envoy Proxy](https://envoyproxy.io) that comes with a simple yet powerful control plane for managing Envoy as an edge ingress, API Gateway, or service proxy. Gloo Edge's control plane is built on a plugin model that enables extension and customization depending on your environment and comes with an out-of-the-box Discovery plugin that automatically discovers various types of services. These services include Kubernetes or Consul services, external services on VMs, or services that are deployed as serverless functions on a public cloud, such as Cloud Functions. This flexibility lets Gloo Edge adapt both to the fast pace of development in the open source Envoy community, as well as to the unique needs of differing operational environments.

### What are Gloo Edge's primary use cases?

Expand Down

0 comments on commit 5c1da87

Please sign in to comment.