Skip to content

Commit

Permalink
Add keywords and description for docs
Browse files Browse the repository at this point in the history
Signed-off-by: Carson Yang <[email protected]>
  • Loading branch information
yangchuansheng committed Sep 3, 2024
1 parent b98c787 commit 2eceb67
Show file tree
Hide file tree
Showing 615 changed files with 636 additions and 4,270 deletions.
5 changes: 5 additions & 0 deletions docs/5.0/docs/Intro.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
keywords: [cloud operating system, Kubernetes, Sealos, cloud-native, distributed applications, private cloud, public cloud, high-availability, cluster imaging, app store]
description: Sealos is a cloud operating system based on Kubernetes, enabling effortless cloud usage with high-availability and flexible app store capabilities for both public and private clouds.
---

import Highlight from '@site/src/components/Highlight'

# What is Sealos?
Expand Down
5 changes: 5 additions & 0 deletions docs/5.0/docs/community.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
keywords: [Sealos, open source project, Kubernetes, Discord server, GitHub Issues]
description: Sealos is an open source project driven by user participation. Join our Discord server, tweet at @sealosio, or create GitHub Issues for support.
---

# Community

Sealos is an open source project that is driven by the participation of users and contributors. If you have questions or
Expand Down
2 changes: 2 additions & 0 deletions docs/5.0/docs/developer-guide/lifecycle-management/QA.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 1
keywords: [Sealos, Kubernetes, image building, runtime selection, version compatibility, file storage, FAQ]
description: Comprehensive FAQ for Sealos users covering image building, runtime selection, version compatibility, and file storage issues. Includes solutions and best practices.
---

# Frequently Asked Questions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 2
keywords: [Sealos image building, registry sync, image caching, skopeo copy, lightweight registry]
description: Learn how to enhance Sealos image building with registry sync and skopeo copy for efficient and lightweight image caching.
---

# Guide to Image Building Improvement
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 5
keywords: [dual-stack cluster, Calico, Kubernetes, IPv6, Sealos, cluster configuration, Kubernetes networking, VXLAN, kubeadm, Kubernetes setup]
description: Learn how to install a dual-stack cluster with Calico on Kubernetes using Sealos. Follow our guide for configuring IPv6 and IPv4 networking.
---

# install Dual-stack cluster with Calico
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 1
keywords: [Sealos image building, directory structure, Kubernetes yaml files, Helm chart, Kubefile]
description: Learn how to build Sealos images with a standardized directory structure, including Kubernetes yaml files and Helm charts, for efficient and error-free management.
---

# Image Building and Standard Directory Configuration
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 2
keywords: [Sealos run, Kubernetes deployment, cluster management, Kubernetes images, node synchronization]
description: Learn how the Sealos run command simplifies Kubernetes deployment with detailed steps on node checks, image pulling, configuration rendering, and more.
---

# How Sealos Run Works
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 9
keywords: [Sealos, template rendering, Kubernetes, image building, template functions, configuration files, semantic versioning, Golang templates, cluster image, Kubernetes manifests]
description: Learn how Sealos enhances image building with template rendering and functions for Kubernetes configurations, scripts, and manifests.
---

# Template Inclusion and Function Enhancement
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 0
keywords: [Sealos, cloud operating system, Kubernetes clusters, cloud-native applications, cluster management, container management, image management, cluster images, Sealos user guide, Rootfs cluster images]
description: Explore Sealos, a unified cloud OS for managing Kubernetes clusters and cloud-native apps. Learn about cluster management, containers, and images with our comprehensive user guide.
---

# Kubernetes Lifecycle Management
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 4
keywords: [build cluster image, sealos tool, helm binary, create Sealfile, push image DockerHub]
description: Learn how to use the sealos tool to package a binary file like helm into a cluster image, build it, and push it to DockerHub.
---

# Building Cluster Images Based on Binary Files
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 5
keywords: [build cluster images, go-template, sealos, environment variables, Kubefile, yaml template, helm command, Kubernetes service]
description: Learn how to build cluster images using go-template with sealos, customize environment variables in Kubefile, and render yaml templates for Kubernetes services.
---

# Building Cluster Images Based on go-template
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 3
keywords: [Helm Charts, build cluster image, Kubernetes, sealos, nginx Helm Charts]
description: Learn how to build a cluster image using Helm Charts with sealos, featuring a step-by-step guide for Kubernetes and nginx Helm Charts.
---

# Building Cluster Images Based on Helm Charts
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 1
keywords: [Cluster Images, Image Manifests, Docker Tarballs, Kubernetes, Calico CNI, Image Manifest Support, OCI Container Images, Docker Archive Images]
description: Learn how to build cluster images using image manifests or Docker tarballs with Kubernetes and Calico CNI. Follow our step-by-step guide for seamless image management.
---

# Building Cluster Images Based on Image Manifests
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 2
keywords: [build cluster images, deployment manifest, nginx deployment, Kubernetes yaml, sealos build]
description: Learn how to build cluster images based on deployment manifests using a simple nginx application example with Kubernetes yaml and sealos build.
---

# Building Cluster Images Based on Deployment Manifest
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 6
keywords: [sealos, build cluster image, exec command, scp command, Kubernetes, openebs mayastor, flannel installation, cluster management, hugepages, kernel modules]
description: Learn how to build cluster images using sealos exec and scp commands. Follow step-by-step examples for openebs mayastor and flannel installation.
---

# Building Cluster Images Using exec and scp Commands
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 7
keywords: [Kubernetes cluster, custom images, kubeadm config, Clusterfile, sealos build]
description: Learn how to customize a Kubernetes cluster by building custom images using kubeadm config and sealos build. Follow our step-by-step guide.
---

# Customizing a Kubernetes Cluster by Building Custom Images
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 0
keywords: [Sealos cluster image, build Sealos image, Sealos image building, Sealos advanced building, Sealos multi-stage build]
description: Learn how to effectively build Sealos cluster images with basic and advanced techniques, including multi-stage builds and custom options.
---

# Sealos Cluster Image Building
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 0
keywords: [multi-architecture images, sealos tool, build cluster images, amd64 arm64, container image repository]
description: Learn how to use the sealos tool to build and push multi-architecture cluster images for amd64 and arm64 to a container image repository.
---

# Building Multi-Architecture Cluster Images
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 9
keywords: [helm chart, private image registry, Kubernetes deployment, build service image, sealos]
description: Learn how to build a complete application service using a private image registry with Helm and Sealos. Step-by-step guide for Kubernetes deployment.
---

# Building a Complete Application Service Using a Private Image
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 0
keywords: [Docker Registry, container image management, image synchronization, image backup, Docker security]
description: Learn effective Docker Registry management with guides on security, image handling, synchronization, and troubleshooting.
---

# Sealos Image Repository
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 1
keywords: [Sealos cluster, image synchronization, backup strategy, container images, Sealos registry]
description: Efficient Sealos cluster image synchronization and backup strategy. Learn how to backup and sync container images to reduce bandwidth usage.
---

# Efficient Sealos Cluster Image Synchronization and Backup Strategy
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 2
keywords: [Sealos private registry, container repository, image-cri-shim, Docker configuration, push and pull images]
description: Learn how to use Sealos as a private container repository. Configure Docker, manage images, and ensure seamless operations with Sealos.
---

# How to Use Sealos as a Private Container Repository
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 2
keywords: [Sealos, application images, runtime environment, node-local-dns, Clusterfile, Kubernetes, Helm, cloud image, configuration, customization]
description: Learn how to configure and customize application images and their runtime environment using Sealos, including creating cloud images and Clusterfile for node-local-dns.
---

# Configuring and Customizing Application Images and Their Runtime Environment
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 1
keywords: [Clusterfile, sealos, Kubernetes, custom configuration, cluster management, helm, calico, CIDR range, podSubnet, cluster configuration]
description: Learn how to generate and customize a Clusterfile using sealos for Kubernetes cluster management, including setting up Helm and Calico with specific CIDR ranges.
---

# Custom Configuration Installation
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 0
keywords: [Sealos cluster, Docker images, cluster initialization, node management, service management]
description: Learn how to effectively run and manage a Sealos cluster with Docker images. Get detailed tutorials on cluster initialization, node management, and service management.
---

# Running a Sealos Cluster with Docker Images
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 2
keywords: [Go template, Clusterfile, Kubernetes cluster, sealos, cluster deployment]
description: Learn how to configure and deploy a Kubernetes cluster using Go template syntax with sealos. Follow our guide for a seamless setup.
---

# Template Configuration Installation
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 3
keywords: [Kubernetes upgrade, sealos run, upgrade cluster, Kubernetes v1.25.0, Kubernetes lifecycle management]
description: Learn how to upgrade your Kubernetes cluster using sealos run. Follow our step-by-step guide to ensure a smooth upgrade to Kubernetes v1.25.0.
---

# How to Upgrade the Cluster
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 3
keywords: [nginx ingress, Helm chart, Kubernetes, Docker image, Sealos]
description: Learn how to build an nginx-ingress cluster image using Helm and Sealos, including steps for downloading charts, writing Dockerfiles, and pushing to image registries.
---

# Building an Ingress Cluster Image
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 2
keywords: [K8s, K8s install, K8s deploy, Kubernetes cluster setup, multi-node Kubernetes, offline Kubernetes installation]
keywords: [Kubernetes installation, Sealos CLI, multi-node Kubernetes, Kubernetes cluster setup, offline Kubernetes installation]
description: Learn how to install Kubernetes clusters using Sealos CLI on both amd64 and arm64 architectures, including single-node and multi-node setups, with offline installation support.
---

# Install Kubernetes
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 1
keywords: [sealos, sealos cli]
keywords: [Sealos CLI, Sealos installation, Sealos download, Sealos binary, Sealos package management]
description: Learn how to download and install Sealos CLI with our comprehensive guide, including binary and package management tool installation methods.
---

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 3
keywords: [image-cri-shim, Kubernetes, container runtime, CRI, kubelet, container deployment, image registry, middleware]
description: Learn how image-cri-shim simplifies Kubernetes container deployment by automatically recognizing image names, streamlining the process.
---

# image-cri-shim User Guide
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
keywords: [LVScare, Sealos, Kubernetes high availability, IPVS load balancing, Kubernetes health check]
description: Learn how LVScare and Sealos ensure high availability and reliability of Kubernetes clusters with IPVS-based load balancing and health checks.
---

# LVScare User Guide

## Introduction
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 1
keywords: [Kubernetes certificates, cert command, secure communication, TLS encryption, Kubernetes cluster]
description: Generate secure Kubernetes certificates with the `cert` command to ensure encrypted communication within your cluster using TLS.
---

# Certificate Management with `cert`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 2
keywords: [CRI management, Kubernetes containers, container runtime, sealctl cri, Docker management, containerd, CRI-O, Kubernetes cluster, container operations, cgroup driver]
description: Manage and inspect the Container Runtime Interface (CRI) in Kubernetes with sealctl cri. Check runtime status, list containers, and more.
---

# CRI Container Management
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 3
keywords: [hostname command, sealctl, get hostname, operating system hostname, sealctl hostname]
description: Learn how to use the sealctl command to get the hostname of your operating system effortlessly. No additional parameters required.
---

# Get Hostname
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 4
keywords: [manage hosts, domain name resolution, sealctl command, IP mapping, DNS override]
description: Learn how to manage the hosts file using sealctl commands to list, add, and delete domain-to-IP mappings for better control over DNS resolution.
---

# Manage Hosts
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 6
keywords: [IPVS, load balancing, sealctl ipvs, virtual servers, real servers, Linux kernel, proxy modes, health check, scheduling algorithms]
description: Learn how to use sealctl ipvs command for high-performance load balancing in Linux. Manage virtual and real servers, configure health checks, and optimize your network.
---

# Manage IPVS
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 5
keywords: [sealctl registry serve, Docker image repository, Sealos, filesystem mode, in-memory mode, image synchronization, container registry, Kubernetes]
description: Learn how to use the sealctl registry serve command in Sealos to manage Docker image repositories in filesystem and in-memory modes for Kubernetes environments.
---

# Registry Image Repository
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 0
keywords: [sealctl, Sealos, cluster management, container runtime, IPVS, static pods, certificate management, registry, Kubernetes]
description: Explore Sealctl, the powerful command-line tool for Sealos cluster management. Learn about its subcommands for container runtime, IPVS, static pods, and more.
---

# Sealctl User Guide
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 7
keywords: [static pod, sealctl, lvscare, Kubernetes, kubelet, IPVS, VIP, cluster management, control plane, configuration]
description: Learn how to use sealctl static-pod command to generate and manage static Pods in Kubernetes, focusing on lvscare for IPVS rules and control plane setup.
---

# Static Pod Configuration
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 9
keywords: [sealctl tar, sealctl untar, file compression, file decompression, Sealos commands, archive management, data backup, file migration, command-line tools, Linux utilities]
description: Learn how to use Sealos' sealctl tar and untar commands for efficient file compression and decompression. Ideal for data backup and file migration tasks.
---

# Tar and Untar in Sealos
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 8
keywords: [sealctl token, Kubernetes cluster, worker node authentication, token generation, cluster security, node joining, sealos, cluster management, authentication token, Kubernetes security]
description: Learn how to use the sealctl token command to generate authentication tokens for securely adding worker nodes to your Kubernetes cluster with Sealos.
---

# Token Management
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 11
keywords: [Sealos, Kubernetes cluster images, application images, cluster-image repository, GitHub Actions, Docker images, configuration images, image build workflow, Kubefile, Helm charts]
description: Learn how to use Sealos' cluster-image repository to build and publish application images for Kubernetes clusters, including Docker and configuration images, using GitHub Actions.
---

# Application Cluster Image Usage Guide
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 4
keywords: [sealos add, cluster nodes, Kubernetes cluster, add control nodes, add regular nodes, cluster management, sealos command-line tool, node addition, cluster expansion, Kubernetes administration]
description: Learn how to use the 'sealos add' command to efficiently add control and regular nodes to your Kubernetes cluster. Explore options and best practices for cluster expansion.
---

# Adding Cluster Nodes with `sealos add`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 1
keywords: [sealos apply, Kubernetes cluster, Clusterfile, cluster images, command-line tool, cluster management, sealos command options, Kubernetes deployment]
description: Learn how to use the 'sealos apply' command to start and manage Kubernetes clusters. Explore options, Clusterfile usage, and best practices for efficient cluster deployment.
---

# Starting a Cluster with `sealos apply`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 6
keywords: [sealos build, OCI images, Dockerfile, image building, containerization, Sealfile, Kubefile, build options, image dependencies, Docker Registry]
description: Learn how to use 'sealos build' command to create OCI images with various instruction files, manage dependencies, and optimize your containerization workflow.
---

# Building Images with `sealos build`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 3
keywords: [sealos cert, cluster certificates, API server certificates, Kubernetes certificates, certificate management, alt-names, certificate verification, kubeadm-config, apiserver.crt]
description: Learn how to update Kubernetes cluster certificates using the sealos cert command. Discover options for adding domain names and IP addresses, and verify your updates easily.
---

# Updating Cluster Certificates with `sealos cert`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 0
keywords: [Sealos commands, cluster management, node management, container operations, Kubernetes cluster, cloud-native applications, image registry, Clusterfile, Sealos installation]
description: Comprehensive guide to Sealos commands for managing Kubernetes clusters, nodes, and containers. Learn about cluster operations, image handling, and cloud-native app deployment.
---

# Sealos Command Reference
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 6
keywords: [sealos create, cluster working directory, Sealos command line tool, debugging, image review]
description: Learn how to use the 'sealos create' command to generate a cluster working directory for debugging and image review without executing the actual cluster.
---

# Create Working Directory
Expand Down
Loading

0 comments on commit 2eceb67

Please sign in to comment.