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

Adding a canonical link for search engines. #397

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 4 additions & 0 deletions docs/explanations/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description: Advanced topics in Epinio application development environments
keywords: [epinio, kubernetes, advanced topics]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/explanations/advanced"/>
</head>

## Prerequisites

There are some components, such as an Ingress controller and a Certificate Manager,
Expand Down
4 changes: 4 additions & 0 deletions docs/explanations/detailed-push-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description: The Epinio push process in detail
keywords: [epinio, kubernetes, push process]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/explanations/detailed-push-process"/>
</head>

Epinio makes use of well supported, well known projects.
There is further discussion about this in the
[project principles](principles.md#guidelines-soft-principles) document.
Expand Down
4 changes: 4 additions & 0 deletions docs/explanations/principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description: The design principles Epinio is based upon.
keywords: [epinio, kubernetes, design principles]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/explanations/principles"/>
</head>

These principles guide Epinio's development:

- Good developer experience
Expand Down
4 changes: 4 additions & 0 deletions docs/explanations/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description: Epinio security, concepts and context
keywords: [epinio, kubernetes, security, application development]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/explanations/security"/>
</head>

Epinio secures access to its API with TLS and basic authentication.

Use the `epinio login [URL]` command after installation to save the necessary credentials (user, password) and certificates.
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ doc-type: [how-to]
doc-topic: [contribute-to-epinio]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/contribute"/>
</head>

Epinio welcomes your participation in the project.
Epinio accepts contributions via GitHub issues and pull requests.
This document outlines what you need to make a successful contribution to the project.
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/customization/create_custom_appcharts.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, customize, custom-app-helm-chart]
doc-persona: [epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/customization/create_custom_appcharts"/>
</head>

Epinio deploys applications on Kubernetes as [Helm charts](https://helm.sh/).

By default, Epinio provides a standard Helm chart installation.
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/customization/create_custom_role.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, customize, create-custom-role]
doc-persona: [epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/customization/create_custom_role"/>
</head>

As described in the [Authorization reference](../../references/authorization.md),
Epinio Roles are Kubernetes ConfigMaps with a particular label.

Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/customization/create_custom_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, customize, create-custom-service]
doc-persona: [epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/customization/create_custom_service"/>
</head>

As described [in the Service reference page](../../references/services.md),
Epinio services are nothing but descriptions of Helm charts.
An operator may add more services simply by creating a Custom Resource in the namespace where Epinio is installed.
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/customization/create_git_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, customize, create-git-config]
doc-persona: [epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/customization/create_git_configuration"/>
</head>


As described
[in the Git Configuration reference page](../../references/git_configuration.md),
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/customization/custom_builder.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, customize, create-custom-builder]
doc-persona: [epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/customization/custom_builder"/>
</head>

The default builder image used by Epinio (`paketobuildpacks/builder:full`) may not work for every application.
It could happen if using an unsupported programming language,
or when the application needs staging in a particular way.
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/customization/custom_routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, customize, custom-routes]
doc-persona: [epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/customization/custom_routes"/>
</head>

Epinio has the idea of a "system domain".
You set this domain when installing Epinio (with the `global.domain` helm value).
It must be a [wildcard domain](https://en.wikipedia.org/wiki/Wildcard_DNS_record) and it's used in 2 different cases:
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/customization/export_to_oci_registries.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, customize, export-to-oci-registry]
doc-persona: [epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/customization/export_to_oci_registries"/>
</head>

:::note

This isn't the same topic as **external Epinio registries**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, customization, external-ip-addresses]
doc-persona: [epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/customization/provision_external_ip_for_local_kubernetes"/>
</head>

Some platforms for deploying local Kubernetes clusters don't have the ability to provide external IP addresses when creating Kubernetes services with the service type `LoadBalancer`.
The following steps enable this ability for a few platforms.
You should follow these steps before installing Epinio.
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/customization/setup_export_registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, custom, setup-export-destination-registry]
doc-persona: [epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/customization/setup_export_registry"/>
</head>

:::note

Don't confuse this topic with **external Epinio registries**.
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/customization/setup_external_registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, custom, setup-external-container-registry]
doc-persona: [epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/customization/setup_external_registry"/>
</head>

You can use an external registry for Epinio to store application images.
You can do this by setting the following variables during the `helm install`:

Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/customization/setup_external_s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [how-to, custom, external-s3-storage]
doc-persona: [epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/customization/setup_external_s3"/>
</head>

One of the steps involved in running `epinio push` is storing the requested version of the code in the configured Epinio S3 compatible storage.
By default, Epinio installs and configures [Minio](https://github.com/minio/minio) to use.
This document describes how to configure Epinio to use another S3 compatible storage and skip the Minio installation.
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/customization/setup_routing_secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, custom, setup-routing-secrets]
doc-persona: [epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/customization/setup_routing_secrets"/>
</head>

This is a How-to for operators.

## Introduction
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/customization/using_custom_service_values.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, customize, custom-service-values]
doc-persona: [epinio-operator, epinio-user]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/customization/using_custom_service_values"/>
</head>

## Audience

This documentation is for Epinio operators specifying custom services for users,
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/operations/aws_iam_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ doc-type: [how-to]
doc-topic: [epinio, customize, operations, aws-iam]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/operations/aws_iam_integration"/>
</head>

How-to use Amazon Web Services (AWS) Identity and Access Management (IAM) with Epinio.

## Authentication using an IAM profile
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/operations/install_metrics_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ doc-type: [how-to]
doc-topic: [epinio, customize, operations, metrics-server]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/operations/install_metrics_server"/>
</head>

If you don't have a metrics server in your Kubernetes cluster,
the application Pods (instances) report errors when trying to show metrics (RAM, CPU etc).
You would do this with the command [`epinio app show`](../../references/commands/cli/app/epinio_app_show.md).
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/other/certificate_issuers.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, certificate-issuer]
doc-persona: [epinio-developer, epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/other/certificate_issuers"/>
</head>

Epinio comes with many
[cert-manager ClusterIssuers](https://cert-manager.io/docs/configuration/)
for creating certificates.
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/other/gitjob_push.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, other, gitjob-push]
doc-persona: [epinio-developer, epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/other/gitjob_push"/>
</head>

## Introduction

In certain other "application deployment" solutions,
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/other/minio.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, other, access-minio-service]
doc-persona: [epinio-developer]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/other/minio"/>
</head>

There are several ways to make Epinio's internal S3-compatible MinIO service available to use for debugging.
Here, two are covered,
first exposing the MinIO console web interface,
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/other/port_forwarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, port-forwarding]
doc-persona: [epinio-developer, epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/other/port_forwarding"/>
</head>

This How-to shows how to use port forwarding to access a running application.

You start port forwarding with the `port-forward` command:
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/other/separate_workload_ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, other, ingress-separation]
doc-persona: [epinio-developer, epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/other/separate_workload_ingress"/>
</head>

By default, applications deployed through Epinio share their ingress class with Epinio's API server.

For situations where this kind of behavior isn't wanted you achieve separation with a couple of steps.
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/other/using_custom_appcharts.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, other, custom-app-chart]
doc-persona: [epinio-developer, epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/other/using_custom_appcharts"/>
</head>

Epinio deploys applications on Kubernetes as [Helm charts](https://helm.sh/).

By default, a standard Helm chart is provided at Epinio installation time.
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/use-develop/app_recover.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, recovery]
doc-persona: [epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/use-develop/app_recover"/>
</head>

Epinio uses 3 Kubernetes CRDs to manage its service catalog entries, app charts, and application data.

When deleting a CRD Kubernetes also deletes all associated CRs.
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/use-develop/debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, use-develop, debug]
doc-persona: [epinio-developer, epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/use-develop/debug"/>
</head>

## Java

To debug a Java application you have to set the
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/use-develop/export-and-transfer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, use-develop, application-export-transfer]
doc-persona: [epinio-developer, epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/use-develop/export-and-transfer"/>
</head>

Epinio provides the ability to export all parts of a running application and then use these to run
the application in a different cluster.

Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/use-develop/install_wordpress_application.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, use-develop, install-wordpress]
doc-persona: [epinio-developer, epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/use-develop/install_wordpress_application"/>
</head>

## Create a directory for your application

```console
Expand Down
4 changes: 4 additions & 0 deletions docs/howtos/use-develop/namespaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ doc-topic: [epinio, how-to, multiple-namespace]
doc-persona: [epinio-developer, epinio-operator]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/howtos/use-develop/namespaces"/>
</head>

Like Kubernetes, Epinio has an idea of namespaces, and the means of working with them.
Working with many namespaces is a little different in Epinio than with Kubernetes.

Expand Down
4 changes: 4 additions & 0 deletions docs/installation/dns_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: How to setup DNS for Epinio and associated issues.
keywords: [epinio, kubernetes, k8s, DNS]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/installation/dns_setup"/>
</head>

During an [Epinio installation](install_epinio.md),
you need to specify a "system" domain in the `global.domain` helm field.
You use this field for access to:
Expand Down
4 changes: 4 additions & 0 deletions docs/installation/install_epinio.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: How to install Epinio
keywords: [epinio, kubernetes, k8s, installation, install]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/installation/install_epinio"/>
</head>

## Introduction

Epinio is installed from a single Helm chart.
Expand Down
4 changes: 4 additions & 0 deletions docs/installation/install_epinio_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: How to install the Epinio CLI on Windows, Linux and Mac
keywords: [epinio, install, cli, windows, mac, linux, homebrew]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/installation/install_epinio_cli"/>
</head>

The `epinio` CLI can be used to interact with a cluster with Epinio installed.
Requests to the Epinio API server are authenticated with Basic Auth.
No direct access to the cluster is required (e.g. through kubectl).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: How to install Epinio on EKS, the Elastic Kubernetes Service.
keywords: [kubernetes, epinio, eks, elastic kubernetes service, install]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/installation/other_inst_scenarios/install_epinio_on_eks"/>
</head>

To install on Elastic Kubernetes Service (EKS) this How-to uses these versions:

* [epinio helm chart - v1.6.2](https://github.com/epinio/helm-charts/releases/tag/epinio-1.6.2)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: How to install Epinio on a locally hosted K3d system.
keywords: [kubernetes, k3d, epinio, installation]
---

<head>
<link rel="canonical" href="https://docs.epinio.io/installation/other_inst_scenarios/install_epinio_on_k3d"/>
</head>


This How-to uses these versions:

Expand Down
Loading