mirror of https://github.com/status-im/consul.git
[docs] Guide migration - index, menu, redirects (#5761)
* modify guide index to point to learn * adding to the redirects is a wip, updated the side navigation. * add tracks to list * Fixing redirects * Update website/source/docs/guides/index.html.md Co-Authored-By: judithpatudith <judith@hashicorp.com> * Update website/source/docs/guides/index.html.md Co-Authored-By: judithpatudith <judith@hashicorp.com> * Update website/source/docs/guides/index.html.md Co-Authored-By: judithpatudith <judith@hashicorp.com> * Update website/source/docs/guides/index.html.md Co-Authored-By: judithpatudith <judith@hashicorp.com> * finish out track listings * finishing redirects. * change advanced language to production, add relationship of guides and docs * Update website/source/redirects.txt Co-Authored-By: judithpatudith <judith@hashicorp.com>
This commit is contained in:
Judith Malnick
GitHub
parent
6a58527cd8
commit
feb8e43e3c
|
|
@ -3,63 +3,34 @@ layout: "docs"
|
||||||
page_title: "Guides"
|
page_title: "Guides"
|
||||||
sidebar_current: "docs-guides"
|
sidebar_current: "docs-guides"
|
||||||
description: |-
|
description: |-
|
||||||
This section provides various guides for common actions. Due to the nature of Consul, some of these procedures can be complex, so our goal is to provide guidance to do them safely.
|
This section provides various guides for common actions. Due to the nature of
|
||||||
|
Consul, some of these procedures can be complex, so our goal is to provide
|
||||||
|
guidance to do them safely.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Consul Guides
|
# Consul Guides
|
||||||
|
|
||||||
This section provides various guides for common actions. Due to the nature
|
~> The Consul guides have moved to the [HashiCorp Learn platform](https://learn.hashicorp.com/).
|
||||||
of Consul, some of these procedures can be complex, so our goal is to provide
|
|
||||||
guidance to do them safely.
|
|
||||||
|
|
||||||
The following guides are available:
|
Guides are step by step command-line walkthroughs that demonstrate how to
|
||||||
|
perform common operations using Consul, and complement the feature-focused
|
||||||
|
Consul documentation. Guide content begins with getting-started tracks to help
|
||||||
|
new users learn the basics of Consul, and continues through production-playbook
|
||||||
|
tracks that cover topics like Day 1 and Day 2 operations, production
|
||||||
|
considerations, and recommendations for securing your Consul cluster.
|
||||||
|
|
||||||
* [Adding/Removing Servers](https://learn.hashicorp.com/consul/day-2-operations/advanced-operations/servers) - This guide covers how to safely add and remove Consul servers from the cluster. This should be done carefully to avoid availability outages.
|
You can work through the guides sequentially using the tracks, or just refer to
|
||||||
|
the material that is most relevant to you.
|
||||||
|
|
||||||
* [Agent Communication Encryption](https://learn.hashicorp.com/consul/advanced/day-1-operations/agent-encryption) - This guide covers how to encrypt both gossip and RPC communication.
|
Tracks include:
|
||||||
|
|
||||||
* [Autopilot](https://learn.hashicorp.com/consul/day-2-operations/advanced-operations/autopilot) - This guide covers Autopilot, which provides automatic operator-friendly management of Consul servers.
|
- [Getting Started](https://learn.hashicorp.com/consul/?track=getting-started#getting-started)
|
||||||
|
- [Getting Started with Kubernetes](https://learn.hashicorp.com/consul/?track=getting-started-k8s#getting-started-k8s)
|
||||||
* [Connect in Production](/docs/guides/connect-production.html) - This guide describes critical aspects of operating Consul Connect in Production.
|
- [Day 1: Deploying Your First Datacenter](https://learn.hashicorp.com/consul/?track=datacenter-deploy#datacenter-deploy)
|
||||||
|
- [Day 1: Security and Network Operations](https://learn.hashicorp.com/consul/?track=security-networking#security-networking)
|
||||||
* [Connect with Envoy](/docs/guides/connect-envoy.html) - This guide will describe how to setup a development-mode Consul server and two Envoy proxies on a single machine using Docker.
|
- [Day 1: Kubernetes Operations](https://learn.hashicorp.com/consul/?track=kubernetes#kubernetes)
|
||||||
|
- [Day 2: Advanced Operations and Maintenance](https://learn.hashicorp.com/consul/?track=day-2-operations#day-2-operations)
|
||||||
* [Consul Cluster Monitoring & Metrics](https://learn.hashicorp.com/consul/advanced/day-1-operations/monitoring) - After setting up your first datacenter, it is an ideal time to make sure your cluster is healthy and establish a baseline. This guide will cover several types of metrics in two sections: Consul health and server health.
|
- [Development: Service Discovery](https://learn.hashicorp.com/consul/?track=developer-discovery#developer-discovery)
|
||||||
|
- [Development: Service Segmentation](https://learn.hashicorp.com/consul/?track=developer-segmentation#developer-segmentation)
|
||||||
* [Consul with Containers](/docs/guides/consul-containers.html) - This guide describes critical aspects of operating a Consul cluster that's run inside containers.
|
- [Development: Service Configuration](https://learn.hashicorp.com/consul/?track=developer-configuration#developer-configuration)
|
||||||
|
- [Integrations](https://learn.hashicorp.com/consul/?track=integrations#integrations)
|
||||||
* [Consul Template](/docs/guides/consul-template.html) - This guide covers the Consul template tool, which provides a programmatic method for populating values into the file system.
|
|
||||||
|
|
||||||
* [Consul-AWS](/docs/guides/consul-aws.html) - This guide covers the Consul-AWS tool, which syncs Consul's and AWS Cloud Map's service catalog.
|
|
||||||
|
|
||||||
* [Creating Certificates](https://learn.hashicorp.com/consul/advanced/day-1-operations/certificates) - This guide describes how to setup CA and certificates to secure a Consul cluster with TLS.
|
|
||||||
|
|
||||||
* [Datacenter Backups](https://learn.hashicorp.com/consul/advanced/day-1-operations/backup) - Consul provide the snapshot tool for backing up and restoring data. In this guide you will learn how to use both.
|
|
||||||
|
|
||||||
* [Deployment Guide](https://learn.hashicorp.com/consul/advanced/day-1-operations/deployment-guide) - This deployment guide covers the steps required to install and configure a single HashiCorp Consul cluster as defined in the Consul Reference Architecture.
|
|
||||||
|
|
||||||
* [DNS Caching](https://learn.hashicorp.com/consul/day-2-operations/advanced-operations/dns-caching) - Enabling TTLs for DNS query caching
|
|
||||||
|
|
||||||
* [DNS Forwarding](/docs/guides/forwarding.html) - Forward DNS queries from Bind to Consul
|
|
||||||
|
|
||||||
* [External Services](/docs/guides/external.html) - This guide covers registering an external service. This allows using 3rd party services within the Consul framework.
|
|
||||||
|
|
||||||
* Federation ([Basic](/docs/guides/datacenters.html) and [Advanced](/docs/guides/advanced-federation.html)) - Configuring Consul to support multiple datacenters.
|
|
||||||
|
|
||||||
* [Geo Failover](/docs/guides/geo-failover.html) - This guide covers using [prepared queries](/api/query.html) to implement geo failover for services.
|
|
||||||
|
|
||||||
* [Minikube with Consul](https://learn.hashicorp.com/consul/getting-started-k8s/minikube/) - In this guide, you'll start a local Kubernetes cluster with minikube, install Consul,and then deploy two custom services.
|
|
||||||
|
|
||||||
* [Leader Election](/docs/guides/leader-election.html) - The goal of this guide is to cover how to build client-side leader election using Consul.
|
|
||||||
|
|
||||||
* [Monitoring Consul with Telegraf](/docs/guides/monitoring-telegraf.html) - This guide demonstrates how to setup Consul for monitoring with Telegraf.
|
|
||||||
|
|
||||||
* [Network Segments](/docs/guides/network-segments.html) - Configuring Consul to support partial LAN connectivity using Network Segments.
|
|
||||||
|
|
||||||
* [Outage Recovery](https://learn.hashicorp.com/consul/day-2-operations/advanced-operations/outage) - This guide covers recovering a cluster that has become unavailable due to server failures.
|
|
||||||
|
|
||||||
* [Consul Reference Architecture](https://learn.hashicorp.com/consul/advanced/day-1-operations/reference-architecture) - This document provides recommended practices and a reference architecture, including system requirements, datacenter design, networking, and performance optimizations for Consul production deployments.
|
|
||||||
|
|
||||||
* [Semaphore](/docs/guides/semaphore.html) - This guide covers using the KV store to implement a semaphore.
|
|
||||||
|
|
||||||
* [Windows Service](/docs/guides/windows-guide.html) - This guide covers how to run Consul as a service on Windows.
|
|
||||||
|
|
|
||||||
|
|
@ -550,86 +550,6 @@
|
||||||
|
|
||||||
<li<%= sidebar_current("docs-guides") %>>
|
<li<%= sidebar_current("docs-guides") %>>
|
||||||
<a href="/docs/guides/index.html">Guides</a>
|
<a href="/docs/guides/index.html">Guides</a>
|
||||||
<ul class="nav">
|
|
||||||
<li<%= sidebar_current("docs-guides-servers") %>>
|
|
||||||
<a href="https://learn.hashicorp.com/consul/day-2-operations/advanced-operations/servers">Adding & Removing Servers</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-agent-encryption") %>>
|
|
||||||
<a href="https://learn.hashicorp.com/consul/advanced/day-1-operations/agent-encryption">Agent Communication Encryption</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-autopilot") %>>
|
|
||||||
<a href="https://learn.hashicorp.com/consul/day-2-operations/advanced-operations/autopilot">Autopilot</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-connect-production") %>>
|
|
||||||
<a href="/docs/guides/connect-production.html">Connect in Production</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-connect-envoy") %>>
|
|
||||||
<a href="/docs/guides/connect-envoy.html">Connect with Envoy</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-consul-cluster-monitoring-metrics") %>>
|
|
||||||
<a href="https://learn.hashicorp.com/consul/advanced/day-1-operations/monitoring">Consul Cluster Monitoring & Metrics</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-consul-containers") %>>
|
|
||||||
<a href="/docs/guides/consul-containers.html">Consul with Containers</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-consul-template") %>>
|
|
||||||
<a href="/docs/guides/consul-template.html">Consul Template</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-consul-aws") %>>
|
|
||||||
<a href="/docs/guides/consul-aws.html">Consul-AWS</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-creating-certificates") %>>
|
|
||||||
<a href="https://learn.hashicorp.com/consul/advanced/day-1-operations/certificates">Creating TLS Certificates</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-backups") %>>
|
|
||||||
<a href="https://learn.hashicorp.com/consul/advanced/day-1-operations/backup">Datacenter Backups</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-deployment-guide") %>>
|
|
||||||
<a href="https://learn.hashicorp.com/consul/advanced/day-1-operations/deployment-guide">Deployment Guide</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-dns-cache") %>>
|
|
||||||
<a href="https://learn.hashicorp.com/consul/day-2-operations/advanced-operations/dns-caching">DNS Caching</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-forwarding") %>>
|
|
||||||
<a href="/docs/guides/forwarding.html">DNS Forwarding</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-external") %>>
|
|
||||||
<a href="/docs/guides/external.html">External Services</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-areas") %>>
|
|
||||||
<a href="/docs/guides/advanced-federation.html">Federation (Advanced)</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-datacenters") %>>
|
|
||||||
<a href="/docs/guides/datacenters.html">Federation (Basic)</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-geo-failover") %>>
|
|
||||||
<a href="/docs/guides/geo-failover.html">Geo Failover</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-leader") %>>
|
|
||||||
<a href="/docs/guides/leader-election.html">Leader Election</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-minikube") %>>
|
|
||||||
<a href="https://learn.hashicorp.com/consul/getting-started-k8s/minikube/">Minikube with Consul</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-monitoring-telegraf") %>>
|
|
||||||
<a href="/docs/guides/monitoring-telegraf.html">Monitoring Consul with Telegraf</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-segments") %>>
|
|
||||||
<a href="/docs/guides/network-segments.html">Network Segments</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-outage") %>>
|
|
||||||
<a href="https://learn.hashicorp.com/consul/day-2-operations/advanced-operations/outage">Outage Recovery</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-reference-architecture") %>>
|
|
||||||
<a href="https://learn.hashicorp.com/consul/advanced/day-1-operations/reference-architecture">Reference Architecture</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-semaphore") %>>
|
|
||||||
<a href="/docs/guides/semaphore.html">Semaphore</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-guides-windows-service") %>>
|
|
||||||
<a href="/docs/guides/windows-guide.html">Windows (Service)</a>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li<%= sidebar_current("docs-faq") %>>
|
<li<%= sidebar_current("docs-faq") %>>
|
||||||
|
|
|
||||||
|
|
@ -57,16 +57,30 @@
|
||||||
/docs/commands/acl/acl-translate-rules.html https://www.consul.io/docs/commands/acl/translate-rules.html
|
/docs/commands/acl/acl-translate-rules.html https://www.consul.io/docs/commands/acl/translate-rules.html
|
||||||
|
|
||||||
# Consul Learn Redirects
|
# Consul Learn Redirects
|
||||||
/docs/guides/acl.html https://learn.hashicorp.com/consul/advanced/day-1-operations/acl-guide
|
/docs/guides/acl.html https://learn.hashicorp.com/consul/security-networking/production-acls
|
||||||
/docs/guides/agent-encryption.html https://learn.hashicorp.com/consul/advanced/day-1-operations/agent-encryption
|
/docs/guides/agent-encryption.html https://learn.hashicorp.com/consul/security-networking/agent-encryption
|
||||||
/docs/guides/autopilot.html https://learn.hashicorp.com/consul/day-2-operations/advanced-operations/autopilot
|
/docs/guides/autopilot.html https://learn.hashicorp.com/consul/day-2-operations/autopilot
|
||||||
/docs/guides/backup.html https://learn.hashicorp.com/consul/advanced/day-1-operations/backup
|
/docs/guides/backup.html https://learn.hashicorp.com/consul/datacenter-deploy/backup
|
||||||
/docs/guides/cluster-monitoring-metrics.html https://learn.hashicorp.com/consul/advanced/day-1-operations/monitoring
|
/docs/guides/cluster-monitoring-metrics.html https://learn.hashicorp.com/consul/day-2-operations/monitoring
|
||||||
/docs/guides/creating-certificates.html https://learn.hashicorp.com/consul/advanced/day-1-operations/certificates
|
/docs/guides/creating-certificates.html https://learn.hashicorp.com/consul/security-networking/certificates
|
||||||
/docs/guides/deployment-guide.html https://learn.hashicorp.com/consul/advanced/day-1-operations/deployment-guide
|
/docs/guides/deployment-guide.html https://learn.hashicorp.com/consul/datacenter-deploy/deployment-guide
|
||||||
/docs/guides/deployment.html https://learn.hashicorp.com/consul/advanced/day-1-operations/reference-architecture
|
/docs/guides/deployment.html https://learn.hashicorp.com/consul/datacenter-deploy/reference-architecture
|
||||||
/docs/guides/dns-cache.html https://learn.hashicorp.com/consul/day-2-operations/advanced-operations/dns-caching
|
/docs/guides/dns-cache.html https://learn.hashicorp.com/consul/security-networking/dns-caching
|
||||||
/docs/guides/minikube.html https://learn.hashicorp.com/consul/getting-started-k8s/minikube
|
/docs/guides/minikube.html https://learn.hashicorp.com/consul/getting-started-k8s/minikube
|
||||||
|
/docs/guides/connect-production.html https://learn.hashicorp.com/consul/developer-segmentation/connect-production
|
||||||
|
/docs/guides/connect-envoy.html https://learn.hashicorp.com/consul/developer-segmentation/connect-envoy
|
||||||
|
/docs/guides/consul-template.html https://learn.hashicorp.com/consul/developer-configuration/consul-template
|
||||||
|
/docs/guides/consul-aws.html https://learn.hashicorp.com/consul/integrations/consul-aws
|
||||||
|
/docs/guides/forwarding.html https://learn.hashicorp.com/consul/security-networking/forwarding
|
||||||
|
/docs/guides/external.html https://learn.hashicorp.com/consul/developer-discovery/external
|
||||||
|
/docs/guides/advanced-federation.html https://learn.hashicorp.com/consul/day-2-operations/advanced-federation
|
||||||
|
/docs/guides/datacenters.html https://learn.hashicorp.com/consul/security-networking/datacenters
|
||||||
|
/docs/guides/geo-failover.html https://learn.hashicorp.com/consul/developer-discovery/geo-failover
|
||||||
|
/docs/guides/leader-election.html https://learn.hashicorp.com/consul/developer-configuration/elections
|
||||||
|
/docs/guides/monitoring-telegraf.html https://learn.hashicorp.com/consul/integrations/telegraf
|
||||||
|
/docs/guides/network-segments.html https://learn.hashicorp.com/consul/day-2-operations/network-segments
|
||||||
|
/docs/guides/semaphore.html https://learn.hashicorp.com/consul/developer-configuration/semaphore
|
||||||
|
/docs/guides/windows-guide.html https://learn.hashicorp.com/consul/datacenter-deploy/windows
|
||||||
|
|
||||||
# NOTE: Do not use this redirects file for intro doc links.
|
# NOTE: Do not use this redirects file for intro doc links.
|
||||||
# A custom VCL (Varnish) configuration in the Fastly web admin has been
|
# A custom VCL (Varnish) configuration in the Fastly web admin has been
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue