Skip to content

Commit

Permalink
Fix relative link confusion.
Browse files Browse the repository at this point in the history
Signed-off-by: Thomas Hallgren <[email protected]>
  • Loading branch information
thallgren committed Sep 3, 2024
1 parent c0f571b commit 2b2e760
Show file tree
Hide file tree
Showing 12 changed files with 19 additions and 40 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ jobs:
- name: "yarn run gatsby build"
run: |
# The sed part of this command removes terminal escape codes.
NODE_ENV=development yarn run gatsby build 2> >(tee /dev/stdout | sed $'s/\e[^a-z]*[a-z]//g' > err.log)
- run: |
! grep ^ err.log
NODE_ENV=development yarn run gatsby build
- name: "Dirty check"
run: |
git add .
Expand Down
2 changes: 1 addition & 1 deletion docs/v2.19/doc-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- title: Install Telepresence
items:
- title: Install Client
link: install/
link: install/client/
- title: Upgrade Client
link: install/upgrade/
- title: Install Traffic Manager
Expand Down
2 changes: 1 addition & 1 deletion docs/v2.19/howtos/intercepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Telepresence enables you to create intercepts to a target Kubernetes workload. O

## Prerequisites

Before you begin, you need to have [Telepresence installed](../install), and either the Kubernetes command-line tool, [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/), or the OpenShift Container Platform command-line interface, [`oc`](https://docs.openshift.com/container-platform/4.2/cli_reference/openshift_cli/getting-started-cli.html#cli-installing-cli_cli-developer-commands). This document uses kubectl in all example commands. OpenShift users can substitute oc [commands instead](https://docs.openshift.com/container-platform/4.1/cli_reference/developer-cli-commands.html).
Before you begin, you need to have [Telepresence installed](../install/client), and either the Kubernetes command-line tool, [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/), or the OpenShift Container Platform command-line interface, [`oc`](https://docs.openshift.com/container-platform/4.2/cli_reference/openshift_cli/getting-started-cli.html#cli-installing-cli_cli-developer-commands). This document uses kubectl in all example commands. OpenShift users can substitute oc [commands instead](https://docs.openshift.com/container-platform/4.1/cli_reference/developer-cli-commands.html).

This guide assumes you have a Kubernetes deployment and service accessible publicly by an ingress controller, and that you can run a copy of that service on your laptop.

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/v2.19/install/manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Telepresence uses a traffic manager to send/recieve cloud traffic to the user. T

## Prerequisites

Before you begin, you need to have [Telepresence installed](../install/).
Before you begin, you need to have [Telepresence installed](../install/client).

If you are not the administrator of your cluster, you will need [administrative RBAC permissions](../reference/rbac#administrating-telepresence) to install and use Telepresence in your cluster.

Expand Down
6 changes: 3 additions & 3 deletions docs/v2.19/quick-start/index.md → docs/v2.19/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ Telepresence is an open source tool that enables you to set up remote developmen

## Install Telepresence

Follow [Install Client](../install) and [Install Traffic Manager](../install/manager) instructions to install the
Follow [Install Client](install/client) and [Install Traffic Manager](install/manager) instructions to install the
telepresence client on your workstation, and the traffic manager in your cluster.

## Intercept Your Service

With Telepresence, you can create [intercepts](../concepts/intercepts?intercept=global) that intercept all traffic going to a service in your remote cluster and route it to your local environment instead.
With Telepresence, you can create [intercepts](concepts/intercepts?intercept=global) that intercept all traffic going to a service in your remote cluster and route it to your local environment instead.

1. Connect to your cluster with `telepresence connect` and connect to the Kubernetes API server:

Expand Down Expand Up @@ -117,6 +117,6 @@ Now, with Telepresence, you can:
</Alert>

## What’s Next?
- [Learn about the Telepresence architecture.](../reference/architecture)
- [Learn about the Telepresence architecture.](reference/architecture)

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=d842651a-2e4d-465a-98e1-4808722c01ab" />
1 change: 0 additions & 1 deletion docs/v2.19/reference/cluster-config.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import Alert from '@material-ui/lab/Alert';
import { ClusterConfig } from '@src/components/Docs/Telepresence';

# Cluster-side configuration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ description: "Learn how to troubleshoot common issues related to Telepresence, i

## Connecting to a cluster via VPN doesn't work.

There are a few different issues that could arise when working with a VPN. Please see the [dedicated page](../reference/vpn) on Telepresence and VPNs to learn more on how to fix these.
There are a few different issues that could arise when working with a VPN. Please see the [dedicated page](reference/vpn) on Telepresence and VPNs to learn more on how to fix these.

## Connecting to a cluster hosted in a VM on the workstation doesn't work

The cluster probably has access to the host's network and gets confused when it is mapped by Telepresence.
Please check the [cluster in hosted vm](../howtos/cluster-in-vm) for more details.
Please check the [cluster in hosted vm](howtos/cluster-in-vm) for more details.

## Volume mounts are not working on macOS

Expand Down Expand Up @@ -76,7 +76,7 @@ $ telepresence upload-traces traces.gz $OTLP_GRPC_ENDPOINT

Once that's been done, the traces will be visible via whatever means your usual collector allows. For example, this is what they look like when loaded into Jaeger's [OTLP API](https://www.jaegertracing.io/docs/1.36/apis/#opentelemetry-protocol-stable):

![Jaeger Interface](../images/tracing.png)
![Jaeger Interface](images/tracing.png)

**Note:** The host and port provided for the `OTLP_GRPC_ENDPOINT` must accept OTLP formatted spans (instead of e.g. Jaeger or Zipkin specific spans) via a GRPC API (instead of the HTTP API that is also available in some collectors)
**Note:** Since traces are not automatically shipped to the backend by telepresence, they are stored in memory. Hence, to avoid running telepresence components out of memory, only the last 10MB of trace data are available for export.
Expand Down Expand Up @@ -104,7 +104,7 @@ Traffic Manager's webhook injector from the API server.
To fix this, add a firewall rule allowing your cluster's master nodes to access TCP port `443` in your cluster's pods,
or change the port number that Telepresence is using for the agent injector by providing the number of an allowed port
using the Helm chart value `agentInjector.webhook.port`.
Please refer to the [telepresence install instructions](../install/cloud#gke) or the [GCP docs](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#add_firewall_rules) for information to resolve this.
Please refer to the [telepresence install instructions](install/cloud#gke) or the [GCP docs](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#add_firewall_rules) for information to resolve this.

## Injected init-container doesn't function properly

Expand Down Expand Up @@ -156,7 +156,7 @@ not get remapped. A headless service will always require the init-container.
## Error connecting to GKE or EKS cluster

GKE and EKS require a plugin that utilizes their resepective IAM providers.
You will need to install the [gke](../install/cloud#gke-authentication-plugin) or [eks](../install/cloud#eks-authentication-plugin) plugins
You will need to install the [gke](install/cloud#gke-authentication-plugin) or [eks](install/cloud#eks-authentication-plugin) plugins
for Telepresence to connect to your cluster.

## `too many files open` error when running `telepresence connect` on Linux
Expand Down
23 changes: 0 additions & 23 deletions src/components/Docs/Telepresence/ClusterConfig.js

This file was deleted.

1 change: 0 additions & 1 deletion src/components/Docs/Telepresence/index.js

This file was deleted.

2 changes: 1 addition & 1 deletion src/components/Link/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const Link = ({ children, ...props}) => {
return <ScrollLink smooth={true} {...props}>{children}</ScrollLink>
} else {
// internal link to a different page
return <GatsbyLink to={to}>{children}</GatsbyLink>
return <GatsbyLink to={'../'+to}>{children}</GatsbyLink>
}
};

Expand Down
6 changes: 6 additions & 0 deletions src/templates/doc-page.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ const mdxComponents = {
// Override default markdown output.
'pre': CodeBlock,
'a': Link,
img({ children, ...props}) {
if (props.src.indexOf('//') << 0 && props.src.indexOf('../') << 0) {
props.src = '../'+props.src
}
return <img {...props}>{children}</img>;
},

// Add new custom components.
// (none right now)
Expand Down

0 comments on commit 2b2e760

Please sign in to comment.