Skip to content

Commit

Permalink
Style updates for product docs (#7049)
Browse files Browse the repository at this point in the history
* Initial style edits

* Additional edits

* Updated back end and front end terminology in product docs

* Updated terms filename and backward

* Remove duplicate Gitea redirect

* Fixed Cloud Manager terminology in product docs
  • Loading branch information
wildmanonline authored Jul 30, 2024
1 parent 081c44b commit e75358d
Show file tree
Hide file tree
Showing 295 changed files with 912 additions and 912 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ This guide walks you through the steps needed to deploy a Kubernetes cluster usi

## Create your Pulumi Infrastructure Code

Create Pulumi infrastructure code that define the resources needed to create a Kubernetes cluster. You can create a minimal Pulumi project containing your [resources](https://www.pulumi.com/docs/concepts/resources/), a [stack](https://www.pulumi.com/docs/concepts/stack/) which is an instance of your Pulumi program, and the [configuration values](https://www.pulumi.com/docs/concepts/config/) for your stack. Setting up your Pulumi project in this way allows you to reuse your Pulumi program to deploy more Kubernetes clusters, if desired, by way of additional stacks.
Create Pulumi infrastructure code that define the resources needed to create a Kubernetes cluster. You can create a minimal Pulumi project containing your [resources](https://www.pulumi.com/docs/concepts/resources/), a [stack](https://www.pulumi.com/docs/concepts/stack/) which is an instance of your Pulumi program, and the [configuration values](https://www.pulumi.com/docs/concepts/config/) for your stack. Setting up your Pulumi project in this way lets you reuse your Pulumi program to deploy more Kubernetes clusters, if desired, by way of additional stacks.

### Create your Pulumi project

Expand Down Expand Up @@ -260,7 +260,7 @@ Now that all your Pulumi configuration is ready, you can deploy your Kubernetes
Now that your Kubernetes cluster is deployed, you can use kubectl to connect to it and begin defining your workload. Access your cluster's kubeconfig and use it to connect to your cluster with kubectl.
1. Use Pulumi to access your cluster's kubeconfig, decode its contents, and save them to a file. Pulumi returns a [base64](https://en.wikipedia.org/wiki/Base64) encoded string (a useful format for automated pipelines) representing your kubeconfig. Replace `lke-cluster-config.yaml` with your preferred file name.
1. Use Pulumi to access your cluster's kubeconfig, decode its contents, and save them to a file. Pulumi returns a [base64](https://en.wikipedia.org/wiki/Base64) encoded string (a useful format for automated pipelines) representing your kubeconfig. Replace `lke-cluster-config.yaml` with your preferred filename.
```command
export KUBE_VAR=`pulumi stack output kubeconfig --show-secrets` && echo $KUBE_VAR | base64 -di > lke-cluster-config.yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Terraform defines the elements of your Linode infrastructure inside of configura
This file contains your cluster’s main configuration arguments and output variables. In this example, you make use of Terraform’s input variables so that your `main.tf` configuration can be easily reused across different clusters.
Variables and their values will be created in separate files later on in this guide. Using separate files for variable declaration allows you to avoid hard-coding values into your resources. This strategy can help you reuse, share, and version control your Terraform configurations.
Variables and their values will be created in separate files later on in this guide. Using separate files for variable declaration lets you avoid hard-coding values into your resources. This strategy can help you reuse, share, and version control your Terraform configurations.
This configuration file uses the Linode provider to create a Kubernetes cluster. All arguments within the `linode_lke_cluster.foobar` resource are required, except for `tags`. The `pool` argument accepts a list of pool objects. In order to read their input variable values, the configuration file makes use of Terraform's [dynamic blocks](https://www.terraform.io/docs/configuration/expressions.html#dynamic-blocks). Finally, [output values](https://www.terraform.io/docs/configuration/outputs.html) are declared in order to capture your cluster's attribute values that will be returned to Terraform after creating your cluster.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ Next, you need to determine which partition your root file system is installed o
### Transfer the System to a New Ext4 Disk
This next step involves making changes to your disks and configuration profiles, which then allows you to transfer your data to a *ext4* formatted disk.
This next step involves making changes to your disks and configuration profiles, which then lets you transfer your data to a *ext4* formatted disk.
1. In the Cloud Manager, navigate to the **Storage** tab. From here, you can delete the *Installer* disk and create two additional disks.
Expand Down Expand Up @@ -346,4 +346,4 @@ You now should have a Linux system that's compatible with the Linode Platform. F

## Save the System as a Custom Image

If you wish to save a copy of this system to quickly deploy later, you may want to use Linode's Custom Image feature. This allows you to create a Compute Instance based on this system without needing to go through this guide again. See [Capture an Image](/docs/products/tools/images/guides/capture-an-image/) for instructions on creating the image.
If you wish to save a copy of this system to quickly deploy later, you may want to use Linode's Custom Image feature. This lets you create a Compute Instance based on this system without needing to go through this guide again. See [Capture an Image](/docs/products/tools/images/guides/capture-an-image/) for instructions on creating the image.
2 changes: 1 addition & 1 deletion docs/products/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title = "All Products"
linkTitle = "Products"
title_meta = "Linode Product Documentation"
description = "Get started using the Cloud Manager, CLI, and API to deploy Linode services and manage your account."
description = "Get started using Cloud Manager, CLI, and API to deploy Linode services and manage your account."

[[cascade]]
weightAge = 0
Expand Down
4 changes: 2 additions & 2 deletions docs/products/compute/compute-instances/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ In addition to the resources allocated to each available plan (outlined above),
- Dedicated IPv4 and IPv6 addresses (additional addresses available on request)
- Deploy using the many available [Linux Distributions](https://www.linode.com/distributions/), [Marketplace Apps](https://www.linode.com/marketplace/), or Community [StackScripts](https://www.linode.com/products/stackscripts/)
- Direct console access through [Lish](/docs/products/compute/compute-instances/guides/lish/)
- Provisioning and management through the [Cloud Manager](https://cloud.linode.com/), [Linode CLI](https://www.linode.com/products/cli/), or programmatically through the [Linode API](https://www.linode.com/products/linode-api/)
- Provisioning and management through [Cloud Manager](https://cloud.linode.com/), [Linode CLI](https://www.linode.com/products/cli/), or programmatically through the [Linode API](https://www.linode.com/products/linode-api/)
- [Multi-queue NIC](/docs/products/compute/compute-instances/guides/multiqueue-nic/) support on plans with 2 or more vCPU cores.

\**If a service is not active for the entire month, the amount of network transfer allowance is prorated based on the number of hours the service is active.*
Expand All @@ -50,7 +50,7 @@ Linode bundles the following services with all Compute Instances:
- Seamless firewall management with [Cloud Firewalls](https://www.linode.com/products/cloud-firewall/)
- Private Layer 2 networks with [VLANs](https://www.linode.com/products/vlan/)
- Physical placement of your Compute Instances in a data center with [Placement Groups](/docs/products/compute/compute-instances/guides/placement-groups/)
- Metrics and monitoring through the [Cloud Manager](https://www.linode.com/products/monitoring/) and [Longview](/docs/products/tools/longview/) (free plan)
- Metrics and monitoring through [Cloud Manager](https://www.linode.com/products/monitoring/) and [Longview](/docs/products/tools/longview/) (free plan)
- Reusable deployment scripts through [StackScripts](https://www.linode.com/products/stackscripts/)

## Complementary Paid Services
Expand Down
4 changes: 2 additions & 2 deletions docs/products/compute/compute-instances/developers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ Linode’s [API v4](/docs/api) provides the ability to programmatically manage t

## Linode CLI

The [Linode CLI](https://github.com/linode/linode-cli) is a wrapper around the Linode API v4 that allows you to manage your Linode account and resources from the command line. Learn how to use the Linode CLI to [create and manage Linode Instances](/docs/products/tools/cli/guides/linode-instances/).
The [Linode CLI](https://github.com/linode/linode-cli) is a wrapper around the Linode API v4 that lets you manage your Linode account and resources from the command line. Learn how to use the Linode CLI to [create and manage Linode Instances](/docs/products/tools/cli/guides/linode-instances/).

## Third Party Tools & Integrations

**Terraform**: Terraform is an Infrastructure-as-code tool that includes management features for various types of Linode resources. Use Linode’s [official Terraform Provider](https://registry.terraform.io/providers/linode/linode/latest/docs) to [provision Linode Environments](/docs/guides/how-to-build-your-infrastructure-using-terraform-and-linode/). To learn more about Terraform see our documentation library’s [Terraform section](/docs/applications/configuration-management/terraform/).

**Pulumi**: Pulumi is a development tool that allows you to write computer programs which deploy cloud resources. With [Pulumi’s Linode integration](https://github.com/pulumi/pulumi-linode), you can manage your Linode resources in several programming languages, like JavaScript, Go, Python, and TypeScript. Pulumi manages your resources in the same way as Linode's API or CLI. See [Pulumi’s documentation](https://www.pulumi.com/docs/intro/cloud-providers/linode/) to get started.
**Pulumi**: Pulumi is a development tool that lets you write computer programs which deploy cloud resources. With [Pulumi’s Linode integration](https://github.com/pulumi/pulumi-linode), you can manage your Linode resources in several programming languages, like JavaScript, Go, Python, and TypeScript. Pulumi manages your resources in the same way as Linode's API or CLI. See [Pulumi’s documentation](https://www.pulumi.com/docs/intro/cloud-providers/linode/) to get started.

- [Getting Started with Pulumi](/docs/guides/deploy-in-code-with-pulumi/)
18 changes: 9 additions & 9 deletions docs/products/compute/compute-instances/faqs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ First, you might want to give the [Linode Backup Service](http://www.linode.com/

- [Introduction to Rsync](/docs/guides/introduction-to-rsync/): Using `rsync` to mirror files to another server.
- [Using Rdiff-backup with SSHFS](/docs/guides/using-rdiff-backup-with-sshfs/): An easy approach to using the `rdiff-backup` utility to maintain differential backups.
- [Cloning a Disk](/docs/products/compute/compute-instances/guides/clone-instance/#clone-to-an-existing-compute-instance): Creating an exact copy of a disk in the Cloud Manager.
- [Cloning a Disk](/docs/products/compute/compute-instances/guides/clone-instance/#clone-to-an-existing-compute-instance): Creating an exact copy of a disk in Cloud Manager.
- [Copying a Disk Over SSH](/docs/products/compute/compute-instances/guides/copy-a-disk-image-over-ssh/): How to download an exact binary image of your Compute Instance's disk over SSH.

## How can I install software on my Compute Instance?
Expand All @@ -62,17 +62,17 @@ Please refer to our guide on [Linux package management](/docs/guides/linux-packa

## How do I add another IP address?

You may add an [additional public IP address](/docs/products/compute/compute-instances/guides/manage-ip-addresses/#adding-an-ip-address) from the **Networking** tab for each Compute Instance in the Cloud Manager. After you've added a new IP address, you must [configure static networking](/docs/products/compute/compute-instances/guides/manual-network-configuration/) or enable [Network Helper](/docs/products/compute/compute-instances/guides/network-helper/#individual-compute-instance-setting) and reboot your instance before it can be used.
You may add an [additional public IP address](/docs/products/compute/compute-instances/guides/manage-ip-addresses/#adding-an-ip-address) from the **Networking** tab for each Compute Instance in Cloud Manager. After you've added a new IP address, you must [configure static networking](/docs/products/compute/compute-instances/guides/manual-network-configuration/) or enable [Network Helper](/docs/products/compute/compute-instances/guides/network-helper/#individual-compute-instance-setting) and reboot your instance before it can be used.

{{< note >}}
We require technical justification for the issuance of new IP addresses; you may need to open a ticket from the [Support Tickets](https://cloud.linode.com/support/tickets) section of the Cloud Manager explaining the reason for the new IP.
We require technical justification for the issuance of new IP addresses; you may need to open a ticket from the [Support Tickets](https://cloud.linode.com/support/tickets) section of Cloud Manager explaining the reason for the new IP.
{{< /note >}}

If you'd like to take advantage of our private networking feature, you may add a private IP to your Compute Instance from the **Networking** tab for each instance in the Cloud Manager. Private IP addresses are not publicly accessible, although they are accessible from other Compute Instances in the same data center. Although we take measures to prevent others from intercepting your private IP traffic, you may still wish to configure a firewall to allow access from only the Compute Instances that you operate.
If you'd like to take advantage of our private networking feature, you may add a private IP to your Compute Instance from the **Networking** tab for each instance in Cloud Manager. Private IP addresses are not publicly accessible, although they are accessible from other Compute Instances in the same data center. Although we take measures to prevent others from intercepting your private IP traffic, you may still wish to configure a firewall to allow access from only the Compute Instances that you operate.

## How do I set the reverse DNS for an IP address?

To [set rDNS](/docs/products/compute/compute-instances/guides/configure-rdns/), you can use the **More Options** ellipsis next to your Compute Instance's IPv4 address from the **Networking** tab in the Cloud Manager. Please note that the value you specify needs to match an A record or CNAME in DNS pointing to your Compute Instance's IP address. It may take up to 48 hours for reverse DNS updates to take effect.
To [set rDNS](/docs/products/compute/compute-instances/guides/configure-rdns/), you can use the **More Options** ellipsis next to your Compute Instance's IPv4 address from the **Networking** tab in Cloud Manager. Please note that the value you specify needs to match an A record or CNAME in DNS pointing to your Compute Instance's IP address. It may take up to 48 hours for reverse DNS updates to take effect.

## Why does my Compute Instance keep crashing?

Expand All @@ -82,19 +82,19 @@ If an application is crashing, be sure to check its error logs. These are typica

## Why is my connection to my Compute Instance slow or broken?

First, check to be sure that the service (SSH, HTTP, etc.) you're trying to access is running. If your Compute Instance runs a firewall, [check your firewall rules](/docs/guides/control-network-traffic-with-iptables/#view-your-current-iptables-rules) to ensure that you're allowing traffic to the desired destination. If this doesn't help, generate [MTR reports](/docs/guides/diagnosing-network-issues-with-mtr/) to and from your Compute Instance, and [submit them](/docs/products/platform/get-started/guides/support/#contact-customer-support) via the [Support Tickets](https://cloud.linode.com/support/tickets) section in the Cloud Manager. You may need to use [Lish](/docs/products/compute/compute-instances/guides/lish/) if you're having problems reaching your Compute Instance via normal networking.
First, check to be sure that the service (SSH, HTTP, etc.) you're trying to access is running. If your Compute Instance runs a firewall, [check your firewall rules](/docs/guides/control-network-traffic-with-iptables/#view-your-current-iptables-rules) to ensure that you're allowing traffic to the desired destination. If this doesn't help, generate [MTR reports](/docs/guides/diagnosing-network-issues-with-mtr/) to and from your Compute Instance, and [submit them](/docs/products/platform/get-started/guides/support/#contact-customer-support) via the [Support Tickets](https://cloud.linode.com/support/tickets) section in Cloud Manager. You may need to use [Lish](/docs/products/compute/compute-instances/guides/lish/) if you're having problems reaching your Compute Instance via normal networking.

## How can I upgrade or downgrade my Compute Instance?

You can change your Compute Instance's plan by using the Resize feature in the Cloud manager. If you're downgrading, please make sure you've resized your disk images to fit within your desired plan's disk space allocation before issuing the resize job. For instructions, refer to our guide on [Resizing a Compute Instance](/docs/products/compute/compute-instances/guides/resize/).
You can change your Compute Instance's plan by using the Resize feature in Cloud Manager. If you're downgrading, please make sure you've resized your disk images to fit within your desired plan's disk space allocation before issuing the resize job. For instructions, refer to our guide on [Resizing a Compute Instance](/docs/products/compute/compute-instances/guides/resize/).

## How can I test downloads speeds from different data centers?

You may use our [speed test](http://www.linode.com/speedtest/) page to check latency and download speeds from your location to each of our data centers. Many customers with a large Asia-Pacific presence find that our Singapore and Tokyo facilities work best, while those with a visitor base in Europe tend to prefer our London or Frankfurt data centers.

## Can I transfer my Compute Instance to another data center?

Yes. Any time you'd like to transfer your Compute Instance, you can proceed with a migration from the **Disks/Configs** tab for any instance within the [Cloud Manager](https://cloud.linode.com). For more information, see our [Data Center Migration Guide](/docs/products/compute/compute-instances/guides/migrate-to-different-dc/).
Yes. Any time you'd like to transfer your Compute Instance, you can proceed with a migration from the **Disks/Configs** tab for any instance within [Cloud Manager](https://cloud.linode.com). For more information, see our [Data Center Migration Guide](/docs/products/compute/compute-instances/guides/migrate-to-different-dc/).

A migration will result in some changes that will be displayed in a caution message for your review before officially beginning the migration process. Your disks and configuration profiles will move with your Compute Instance, although your IP addresses will need to change. We strongly recommend reviewing this caution message carefully before proceeding for a list of all changes that you can expect.

Expand All @@ -110,4 +110,4 @@ For those just getting started with Linux systems, we've created a series of gui

## Where can I get help with something not covered here?

We always recommend consulting our excellent [user community](https://www.linode.com/community/questions/) first when faced with a question that doesn't seem to be addressed in our documentation. There is also an active community of users available to help on [IRC](https://www.linode.com/chat). If you get stuck you may also open a [support](https://www.linode.com/contact) ticket from the "Get Help" sidebar in the Cloud Manager.
We always recommend consulting our excellent [user community](https://www.linode.com/community/questions/) first when faced with a question that doesn't seem to be addressed in our documentation. There is also an active community of users available to help on [IRC](https://www.linode.com/chat). If you get stuck you may also open a [support](https://www.linode.com/contact) ticket from the "Get Help" sidebar in Cloud Manager.
Loading

0 comments on commit e75358d

Please sign in to comment.