Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: fix the broken links/dead links #26880

Merged
merged 1 commit into from
Jul 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions Documentation/bpf/resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ surrounding ecosystem in user space.

All BPF update newsletters (01 - 12) can be found here:

https://cilium.io/blog/categories/eBPF/
https://cilium.io/blog/categories/technology/5/

And for the news on the latest resources and developments in the eBPF world,
please refer to the link here:
Expand Down Expand Up @@ -577,7 +577,7 @@ related to BPF and XDP:
Polytechnique Montreal,
Trace Aggregation and Collection with eBPF,
Suchakra Sharma,
https://nova.polymtl.ca/~suchakra/eBPF-5May2017.pdf
https://hsdm.dorsal.polymtl.ca/system/files/eBPF-5May2017%20(1).pdf

40. Apr 2017,
DockerCon, Austin,
Expand Down
1 change: 0 additions & 1 deletion Documentation/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,6 @@
# Try as hard as possible to find references
default_role = 'any'


Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: this change is unnecessary.

def setup(app):
app.add_css_file('parsed-literal.css')
app.add_css_file('copybutton.css')
Expand Down
2 changes: 1 addition & 1 deletion Documentation/configuration/argocd-issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ causing one or more of the following issues:
Solution
--------

To prevent these issues, declare resource exclusions in the Argo CD ``ConfigMap`` by following `these instructions <https://argoproj.github.io/argo-cd/operator-manual/declarative-setup/#resource-exclusioninclusion>`__.
To prevent these issues, declare resource exclusions in the Argo CD ``ConfigMap`` by following `these instructions <https://argo-cd.readthedocs.io/en/stable/operator-manual/declarative-setup/#resource-exclusioninclusion>`__.

Here is an example snippet:

Expand Down
2 changes: 1 addition & 1 deletion Documentation/contributing/development/hive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -903,7 +903,7 @@ test against and allows central control over what data (and at what rate)
is pulled from the api-server and how it’s stored (in-memory or persisted).

The resources are usually made available centrally for the application,
e.g. in cilium-agent they’re provided from `pkg/k8s/shared_resources.go <https://github.com/cilium/cilium/blob/main/pkg/k8s/shared_resources.go>`_.
e.g. in cilium-agent they’re provided from `pkg/k8s/resource.go <https://github.com/cilium/cilium/blob/main/daemon/k8s/resources.go>`_.
See also the runnable example in `pkg/k8s/resource/example <https://github.com/cilium/cilium/tree/main/pkg/k8s/resource/example>`_.

.. code-block:: go
Expand Down
6 changes: 3 additions & 3 deletions Documentation/contributing/testing/e2e_legacy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ It offers instructions on setting up and running tests in these modes.

Before proceeding, it is recommended to familiarize yourself with Ginkgo by
reading the `Ginkgo Getting-Started Guide
<https://onsi.github.io/ginkgo/#getting-started-writing-your-first-test>`_. You
<https://onsi.github.io/ginkgo/#getting-started>`_. You
can also run the `example tests
<https://github.com/onsi/composition-ginkgo-example>`_ to get a feel for the
Ginkgo workflow.
Expand Down Expand Up @@ -551,7 +551,7 @@ following files currently are generated depending upon the test suite that is ra
Best Practices for Writing Tests
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Provide informative output to console during a test using the `By construct <https://onsi.github.io/ginkgo/#documenting-complex-its-by>`_. This helps with debugging and gives those who did not write the test a good idea of what is going on. The lower the barrier of entry is for understanding tests, the better our tests will be!
* Provide informative output to console during a test using the `By construct <https://onsi.github.io/ginkgo/#documenting-complex-specs-by>`_. This helps with debugging and gives those who did not write the test a good idea of what is going on. The lower the barrier of entry is for understanding tests, the better our tests will be!
* Leave the testing environment in the same state that it was in when the test started by deleting resources, resetting configuration, etc.
* Gather logs in the case that a test fails. If a test fails while running on Jenkins, a postmortem needs to be done to analyze why. So, dumping logs to a location where Jenkins can pick them up is of the highest imperative. Use the following code in an ``AfterFailed`` method:

Expand All @@ -576,7 +576,7 @@ This method is an equivalent to ``SetUp`` or initialize functions in common
unit test frameworks.

.. _BeforeEach: https://onsi.github.io/ginkgo/#extracting-common-setup-beforeeach
.. _Describe or Context: https://onsi.github.io/ginkgo/#organizing-specs-with-containers-describe-and-context
.. _Describe or Context: https://onsi.github.io/ginkgo/#organizing-specs-with-container-nodes

AfterAll
^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion Documentation/installation/k8s-install-openshift-okd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ OpenShift Requirements

2. Read `OpenShift documentation <https://docs.okd.io/latest/welcome/index.html>`_ to find out about provider-specific prerequisites.

3. `Get OpenShift Installer <https://github.com/openshift/okd#getting-started>`_.
3. `Get OpenShift Installer <https://github.com/okd-project/okd#getting-started>`_.

.. note::

Expand Down
2 changes: 1 addition & 1 deletion Documentation/network/kubernetes/compatibility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ validation version:

.. include:: compatibility-table.rst

.. _networking.k8s.io/v1: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#networkpolicy-v1-networking-k8s-io
.. _networking.k8s.io/v1: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#networkpolicy-v1-networking-k8s-io
2 changes: 1 addition & 1 deletion Documentation/network/kubernetes/kubeproxy-free.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1308,7 +1308,7 @@ the check when running on some cloud providers. E.g. `Amazon NLB
<https://kubernetes.io/docs/concepts/services-networking/service/#aws-nlb-support>`__
natively implements the check, so the kube-proxy replacement's feature can be disabled.
Meanwhile `GKE internal TCP/UDP load balancer
<https://cloud.google.com/kubernetes-engine/docs/how-to/internal-load-balancing#lb_source_ranges>`__
<https://cloud.google.com/kubernetes-engine/docs/how-to/service-parameters#lb_source_ranges>`__
does not, so the feature must be kept enabled in order to restrict the access.

Service Proxy Name Configuration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ tests are passed.
- `GatewayClass <https://gateway-api.sigs.k8s.io/api-types/gatewayclass/>`_
- `Gateway <https://gateway-api.sigs.k8s.io/api-types/gateway/>`_
- `HTTPRoute <https://gateway-api.sigs.k8s.io/api-types/httproute/>`_
- `TLSRoute (experimental) <https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io%2fv1alpha2.TLSRoute/>`_
- `TLSRoute (experimental) <https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1alpha2.TLSRoute>`__
- `ReferenceGrant <https://gateway-api.sigs.k8s.io/api-types/referencegrant/>`_

.. include:: installation.rst
Expand Down
8 changes: 4 additions & 4 deletions Documentation/operations/performance/benchmark.rst
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ All tests are performed using regular off-the-shelf hardware.
============ ======================================================================================================================================================
Item Description
============ ======================================================================================================================================================
CPU `AMD Ryzen 9 3950x <https://www.amd.com/en/products/cpu/amd-ryzen-9-3950x>`_, AM4 platform, 3.5GHz, 16 cores / 32 threads
CPU `AMD Ryzen 9 3950x <https://www.amd.com/en/support/cpu/amd-ryzen-processors/amd-ryzen-9-desktop-processors/amd-ryzen-9-3950x>`_, AM4 platform, 3.5GHz, 16 cores / 32 threads
Mainboard `x570 Aorus Master <https://www.gigabyte.com/us/Motherboard/X570-AORUS-MASTER-rev-11-12/sp#sp>`_, PCIe 4.0 x16 support
Memory `HyperX Fury DDR4-3200 <https://www.hyperxgaming.com/us/memory/fury-ddr4>`_ 128GB, XMP clocked to 3.2GHz
Network Card `Intel E810-CQDA2 <https://ark.intel.com/content/www/us/en/ark/products/192558/intel-ethernet-network-adapter-e810-cqda2.html>`_, dual port, 100Gbit/s per port, PCIe 4.0 x16
Expand Down Expand Up @@ -343,7 +343,7 @@ be found in `cilium/cilium-perf-networking <https://github.com/cilium/cilium-per
All scripts in this document refer to this repository. Specifically, we use
`Terraform <https://www.terraform.io/>`_ and `Ansible
<https://www.ansible.com/>`_ to setup the environment and execute benchmarks.
We use `Packet <https://www.packet.com/>`_ bare metal servers as our hardware
We use `Packet <https://deploy.equinix.com/>`_ bare metal servers as our hardware
platform, but the guide is structured so that it can be easily adapted to other
environments.

Expand All @@ -359,7 +359,7 @@ Packet Servers

To evaluate both :ref:`arch_overlay` and :ref:`native_routing`, we configure
the Packet machines to use a `"Mixed/Hybrid"
<https://www.packet.com/developers/docs/network/advanced/layer-2/>`_ network
<https://deploy.equinix.com/developers/docs/metal/layer2-networking/overview/>`_ network
mode, where the secondary interfaces of the machines share a flat L2 network.
While this can be done on the Packet web UI, we include appropriate Terraform
(version 0.13) files to automate this process.
Expand Down Expand Up @@ -401,7 +401,7 @@ interfaces of the machines. This will destroy the ``bond0`` interface and
configure the first physical interface with the public and private IPs
(``prv_ip``) and the second with the node IP (``node_ip``) that will be used
for our evaluations (see `Packet documentation
<https://www.packet.com/resources/guides/layer-2-configurations/>`_ and our
<https://deploy.equinix.com/developers/docs/metal/layer2-networking/overview/>`_ and our
scripts for more info).

.. code-block:: shell-session
Expand Down
2 changes: 1 addition & 1 deletion Documentation/operations/performance/tuning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ likely it is that various datapath optimizations can be used.

In our Cilium release blogs, we also regularly highlight some of the eBPF based
kernel work we conduct which implicitly helps Cilium's datapath performance
such as `replacing retpolines with direct jumps in the eBPF JIT <https://cilium.io/blog/2020/02/18/cilium-17#linux-kernel-changes>`_.
such as `replacing retpolines with direct jumps in the eBPF JIT <https://cilium.io/blog/2020/02/18/cilium-17#upstream-linux>`_.

Moreover, the kernel allows to configure several options which will help maximize
network performance.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/security/aws.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ AWS Access keys and IAM role
------------------------------

To create a new access token the `following guide can be used
<https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-config>`_.
<https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html>`_.
These keys need to have certain permissions set:

.. code-block:: javascript
Expand Down