Skip to content

Commit

Permalink
Fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
rra committed Sep 18, 2023
1 parent c9a6595 commit 726298b
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Changes for the upcoming release can be found in [changelog.d](https://github.co

### Other changes

- Gafaelfawr now uses the [Ruff](https://beta.ruff.rs/docs/) linter instead of flake8, isort, and pydocstyle.
- Gafaelfawr now uses the [Ruff](https://docs.astral.sh/ruff/) linter instead of flake8, isort, and pydocstyle.

<a id='changelog-9.2.0'></a>
## 9.2.0 (2023-04-19)
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ For protected services that only understand OpenID Connect, Gafaelfawr also incl
This was designed with just enough features to support `Chronograf`_.
It may not work with other applications without additional changes.

.. _Chronograf: https://docs.influxdata.com/chronograf/v1.8/administration/managing-security/
.. _Chronograf: https://docs.influxdata.com/chronograf/v1/administration/managing-security/

Gafaelfawr also deploys a Kubernetes operator to create Gafaelfawr-protected ingresses and maintain service tokens in Kubernetes secrets for the use of other services deployed in the same cluster.
Finally, Gafaelfawr deploys a ``CronJob`` to perform maintenance on its storage, and a ``CronJob`` to audit storage for inconsistencies.
2 changes: 1 addition & 1 deletion docs/dev/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Making this work properly requires some additional NGINX configuration:
This is required on GKE and may be required on other Kubernetes environments.
Do this by adding ``spec.externalTrafficPolicy`` to ``Local`` in the ``Service`` resource definition for the NGINX ingress controller.
This comes with some caveats and drawbacks.
See `this Medium post <https://medium.com/pablo-perez/k8s-externaltrafficpolicy-local-or-cluster-40b259a19404>`__ for more details.
See `the Kubernetes documentation <https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip>`__ for more details.

If you are using the `ingress-nginx Helm chart <https://github.com/kubernetes/ingress-nginx/tree/main/charts/ingress-nginx>`__, you can make both of the required NGINX ingress changes with the following ``values.yaml`` file:

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/openid-connect.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Examples
Chronograf
----------

Assuming that Gafaelfawr and Chronograf are deployed on the host ``example.com`` and Chronograf is at the URL ``/chronograf``, here are the environment variables required to configure `Chronograf <https://docs.influxdata.com/chronograf/v1.9/administration/managing-security/#configure-chronograf-to-use-any-oauth-20-provider>`__:
Assuming that Gafaelfawr and Chronograf are deployed on the host ``example.com`` and Chronograf is at the URL ``/chronograf``, here are the environment variables required to configure `Chronograf <https://docs.influxdata.com/chronograf/v1/administration/managing-security/#configure-chronograf-to-use-any-oauth-20-provider>`__:

* ``GENERIC_CLIENT_ID``: ``chronograf-client-id``
* ``GENERIC_CLIENT_SECRET``: ``fb7518beb61d27aaf20675d62778dea9``
Expand Down

0 comments on commit 726298b

Please sign in to comment.