Skip to content

Commit

Permalink
Remove irrelevant weight field from front matter (k3s-io#271)
Browse files Browse the repository at this point in the history
* Remove irrelevant weight value from front matter

Signed-off-by: Derek Nola <derek.nola@suse.com>

* Remove empty line in advanced pages

Signed-off-by: Derek Nola <derek.nola@suse.com>

---------

Signed-off-by: Derek Nola <derek.nola@suse.com>
  • Loading branch information
dereknola authored Apr 24, 2024
1 parent a04f869 commit fcd1d3c
Show file tree
Hide file tree
Showing 126 changed files with 0 additions and 126 deletions.
1 change: 0 additions & 1 deletion docs/advanced.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Advanced Options / Configuration"
weight: 45
aliases:
- /k3s/latest/en/running/
- /k3s/latest/en/configuration/
Expand Down
1 change: 0 additions & 1 deletion docs/architecture.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Architecture
weight: 1
---

import ThemedImage from '@theme/ThemedImage';
Expand Down
1 change: 0 additions & 1 deletion docs/cli/agent.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: agent
weight: 2
---

# k3s agent
Expand Down
1 change: 0 additions & 1 deletion docs/cli/cli.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: CLI Tools
weight: 1
---

The K3s binary contains a number of additional tools the help you manage your cluster.
Expand Down
1 change: 0 additions & 1 deletion docs/cli/server.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: server
weight: 1
---

# k3s server
Expand Down
1 change: 0 additions & 1 deletion docs/cluster-access.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Cluster Access
weight: 21
---

The kubeconfig file stored at `/etc/rancher/k3s/k3s.yaml` is used to configure access to the Kubernetes cluster. If you have installed upstream Kubernetes command line tools such as kubectl or helm you will need to configure them with the correct kubeconfig path. This can be done by either exporting the `KUBECONFIG` environment variable or by invoking the `--kubeconfig` command line flag. Refer to the examples below for details.
Expand Down
1 change: 0 additions & 1 deletion docs/datastore/backup-restore.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Backup and Restore
weight: 26
---

The way K3s is backed up and restored depends on which type of datastore is used.
Expand Down
1 change: 0 additions & 1 deletion docs/datastore/cluster-loadbalancer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Cluster Load Balancer
weight: 30
---


Expand Down
1 change: 0 additions & 1 deletion docs/datastore/datastore.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Cluster Datastore"
weight: 50
---


Expand Down
1 change: 0 additions & 1 deletion docs/datastore/ha-embedded.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "High Availability Embedded etcd"
weight: 40
---

:::warning
Expand Down
1 change: 0 additions & 1 deletion docs/datastore/ha.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: High Availability External DB
weight: 30
---

This section describes how to install a high-availability K3s cluster with an external database.
Expand Down
1 change: 0 additions & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: FAQ
weight: 60
---

The FAQ is updated periodically and designed to answer the questions our users most frequently ask about K3s.
Expand Down
1 change: 0 additions & 1 deletion docs/helm.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Helm
weight: 42
---

Helm is the package management tool of choice for Kubernetes. Helm charts provide templating syntax for Kubernetes YAML manifest documents. With Helm, developers or cluster administrators can create configurable templates known as Charts, instead of just using static manifests. For more information about creating your own Chart catalog, check out the docs at [https://helm.sh/docs/intro/quickstart/](https://helm.sh/docs/intro/quickstart/).
Expand Down
1 change: 0 additions & 1 deletion docs/installation/airgap.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Air-Gap Install"
weight: 60
---

You can install K3s in an air-gapped environment using two different methods. An air-gapped environment is any environment that is not directly connected to the Internet. You can either deploy a private registry and mirror docker.io, or you can manually deploy images such as for small clusters.
Expand Down
1 change: 0 additions & 1 deletion docs/installation/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Configuration Options"
weight: 20
---

This page focuses on the options that are commonly used when setting up K3s for the first time. Refer to the documentation on [Advanced Options and Configuration](../advanced.md) and the [server](../cli/server.md) and [agent](../cli/agent.md) command documentation for more in-depth coverage.
Expand Down
1 change: 0 additions & 1 deletion docs/installation/installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Installation"
weight: 20
---

This section contains instructions for installing K3s in various environments. Please ensure you have met the [Requirements](requirements.md) before you begin installing K3s.
Expand Down
1 change: 0 additions & 1 deletion docs/installation/packaged-components.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Managing Packaged Components"
weight: 60
---

## Auto-Deploying Manifests (AddOns)
Expand Down
1 change: 0 additions & 1 deletion docs/installation/private-registry.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Private Registry Configuration"
weight: 55
---

Containerd can be configured to connect to private registries and use them to pull images as needed by the kubelet.
Expand Down
1 change: 0 additions & 1 deletion docs/installation/registry-mirror.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Embedded Registry Mirror"
weight: 55
---

:::info Version Gate
Expand Down
1 change: 0 additions & 1 deletion docs/installation/requirements.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Requirements
weight: 1
---

K3s is very lightweight, but has some minimum requirements as outlined below.
Expand Down
1 change: 0 additions & 1 deletion docs/installation/server-roles.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Managing Server Roles"
weight: 60
---

Starting the K3s server with `--cluster-init` will run all control-plane components, including the apiserver, controller-manager, scheduler, and etcd. It is possible to disable specific components in order to split the control-plane and etcd roles on to separate nodes.
Expand Down
1 change: 0 additions & 1 deletion docs/installation/uninstall.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Uninstalling K3s
weight: 61
---

:::warning
Expand Down
1 change: 0 additions & 1 deletion docs/known-issues.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Known Issues
weight: 70
---
The Known Issues are updated periodically and designed to inform you about any issues that may not be immediately addressed in the next upcoming release.

Expand Down
1 change: 0 additions & 1 deletion docs/networking/basic-network-options.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Basic Network Options"
weight: 25
---

This page describes K3s network configuration options, including configuration or replacement of Flannel, and configuring IPv6 or dualStack.
Expand Down
1 change: 0 additions & 1 deletion docs/networking/distributed-multicloud.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Distributed hybrid or multicloud cluster"
weight: 25
---

A K3s cluster can still be deployed on nodes which do not share a common private network and are not directly connected (e.g. nodes in different public clouds). There are two options to achieve this: the embedded k3s multicloud solution and the integration with the `tailscale` VPN provider.
Expand Down
1 change: 0 additions & 1 deletion docs/networking/multus-ipams.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Multus and IPAM plugins"
weight: 25
---

[Multus CNI](https://github.com/k8snetworkplumbingwg/multus-cni) is a CNI plugin that enables attaching multiple network interfaces to pods. Multus does not replace CNI plugins, instead it acts as a CNI plugin multiplexer. Multus is useful in certain use cases, especially when pods are network intensive and require extra network interfaces that support dataplane acceleration techniques such as SR-IOV.
Expand Down
1 change: 0 additions & 1 deletion docs/networking/networking-services.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Networking Services"
weight: 35
---

This page explains how CoreDNS, Traefik Ingress controller, Network Policy controller, and ServiceLB load balancer controller work within K3s.
Expand Down
1 change: 0 additions & 1 deletion docs/networking/networking.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Networking"
weight: 20
---

This section contains instructions for configuring networking in K3s.
Expand Down
1 change: 0 additions & 1 deletion docs/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Quick-Start Guide"
weight: 10
---

This guide will help you quickly launch a cluster with default options. The [installation section](./installation/installation.md) covers in greater detail how K3s can be set up.
Expand Down
1 change: 0 additions & 1 deletion docs/reference/env-variables.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Environment Variables
weight: 3
---

As mentioned in the [Quick-Start Guide](../quick-start.md), you can use the installation script available at https://get.k3s.io to install K3s as a service on systemd and openrc based systems.
Expand Down
1 change: 0 additions & 1 deletion docs/reference/resource-profiling.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Resource Profiling
weight: 1
---

This section captures the results of tests to determine minimum resource requirements for K3s.
Expand Down
1 change: 0 additions & 1 deletion docs/related-projects.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Related Projects"
weight: 10
---

Projects implementing the K3s distribution are welcome additions to help expand the community. This page will introduce you to a range of projects that are related to K3s and can help you further explore its capabilities and potential applications.
Expand Down
1 change: 0 additions & 1 deletion docs/security/hardening-guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "CIS Hardening Guide"
weight: 80
---

This document provides prescriptive guidance for hardening a production installation of K3s. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Internet Security (CIS).
Expand Down
1 change: 0 additions & 1 deletion docs/security/secrets-encryption.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Secrets Encryption
weight: 26
---

# Secrets Encryption Config
Expand Down
1 change: 0 additions & 1 deletion docs/security/security.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Security"
weight: 90
---

This section describes the methodology and means of securing a K3s cluster. It's broken into 2 sections. These guides assume k3s is running with embedded etcd.
Expand Down
1 change: 0 additions & 1 deletion docs/security/self-assessment.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: CIS Self Assessment Guide
weight: 90
---

### CIS Kubernetes Benchmark v1.23 - K3s with Kubernetes v1.22 to v1.24
Expand Down
1 change: 0 additions & 1 deletion docs/storage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Volumes and Storage"
weight: 30
---

When deploying an application that needs to retain data, you’ll need to create persistent storage. Persistent storage allows you to store application data external from the pod running your application. This storage practice allows you to maintain application data, even if the application’s pod fails.
Expand Down
1 change: 0 additions & 1 deletion docs/upgrades/automated.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Automated Upgrades"
weight: 20
---

### Overview
Expand Down
1 change: 0 additions & 1 deletion docs/upgrades/killall.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Stopping K3s
weight: 4
---


Expand Down
1 change: 0 additions & 1 deletion docs/upgrades/manual.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Manual Upgrades"
weight: 10
---

You can upgrade K3s by using the installation script, or by manually installing the binary of the desired version.
Expand Down
1 change: 0 additions & 1 deletion docs/upgrades/upgrades.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Upgrades"
weight: 25
---

### Upgrading your K3s cluster
Expand Down
1 change: 0 additions & 1 deletion i18n/kr/docusaurus-plugin-content-docs/current/advanced.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "고급 옵션 / 설정"
weight: 45
aliases:
- /k3s/latest/kr/running/
- /k3s/latest/kr/configuration/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: 아키텍처
weight: 1
---

import ThemedImage from '@theme/ThemedImage';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: agent
weight: 2
---

# k3s agent
Expand Down
1 change: 0 additions & 1 deletion i18n/kr/docusaurus-plugin-content-docs/current/cli/cli.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: 명령줄 도구
weight: 1
---

K3s 바이너리에는 클러스터 관리에 도움이 되는 여러 가지 추가 도구가 포함되어 있습니다.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: server
weight: 1
---

# k3s server
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: 클러스터 접근
weight: 21
---

`/etc/rancher/k3s/k3s.yaml`에 저장된 kubeconfig 파일은 쿠버네티스 클러스터에 대한 액세스를 구성하는 데 사용됩니다. kubectl 또는 helm과 같은 업스트림 Kubernetes 명령줄 도구를 설치한 경우 올바른 kubeconfig 경로로 구성해야 합니다. 이 작업은 `kubeconfig` 환경 변수를 내보내거나 `--kubeconfig` 명령줄 플래그를 호출하여 수행할 수 있습니다. 자세한 내용은 아래 예시를 참고하세요.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Backup and Restore
weight: 26
---

The way K3s is backed up and restored depends on which type of datastore is used.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Cluster Load Balancer
weight: 30
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "클러스터 데이터 저장소"
weight: 50
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "High Availability Embedded etcd"
weight: 40
---

:::warning
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: High Availability External DB
weight: 30
---

> **Note:** Official support for installing Rancher on a Kubernetes cluster was introduced in our v1.0.0 release.
Expand Down
1 change: 0 additions & 1 deletion i18n/kr/docusaurus-plugin-content-docs/current/faq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: 자주 묻는 질문
weight: 60
---

자주 묻는 질문은 주기적으로 업데이트되며, 사용자가 K3s에 대해 가장 자주 묻는 질문에 대한 답변으로 구성되어 있습니다.
Expand Down
1 change: 0 additions & 1 deletion i18n/kr/docusaurus-plugin-content-docs/current/helm.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: 헬름(Helm)
weight: 42
---

헬름(Helm)은 쿠버네티스를 위한 패키지 관리 도구입니다. 헬름 차트는 쿠버네티스 YAML 매니페스트 문서를 위한 템플릿 구문을 제공합니다. 개발자 또는 클러스터 관리자는 헬름을 사용하여 정적 매니페스트만 사용하는 대신 차트라는 구성 가능한 템플릿을 만들 수 있다. 자신만의 차트 카탈로그 생성에 대한 자세한 내용은 [https://helm.sh/docs/intro/quickstart/](https://helm.sh/docs/intro/quickstart/)에서 문서를 확인하세요.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Air-Gap Install"
weight: 60
---

You can install K3s in an air-gapped environment using two different methods. An air-gapped environment is any environment that is not directly connected to the Internet. You can either deploy a private registry and mirror docker.io, or you can manually deploy images such as for small clusters.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Configuration Options"
weight: 20
---

This page focuses on the options that are commonly used when setting up K3s for the first time. Refer to the documentation on [Advanced Options and Configuration](../advanced.md) and the [server](../cli/server.md) and [agent](../cli/agent.md) command documentation for more in-depth coverage.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Installation"
weight: 20
---

This section contains instructions for installing K3s in various environments. Please ensure you have met the [Requirements](requirements.md) before you begin installing K3s.
Expand Down
Loading

0 comments on commit fcd1d3c

Please sign in to comment.