Skip to content

Commit

Permalink
Merge pull request #7145 from jddocs/rc-v1.355.0
Browse files Browse the repository at this point in the history
[Release Candidate] v1.355.0
  • Loading branch information
jddocs authored Nov 14, 2024
2 parents 9934850 + f5385ad commit c938f1d
Show file tree
Hide file tree
Showing 26 changed files with 79 additions and 87 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/update-algolia-on-schedule.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ jobs:
- name: Set up Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.125.7'
hugo-version: ${{ vars.HUGO_VERSION }}

- name: Checkout docs repo
uses: actions/checkout@v3
Expand Down
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,18 +70,18 @@ To Install the latest Node.js LTS release on Windows, navigate to the [downloads

### Install Hugo

The Linode documentation library is built using [Hugo](http://gohugo.io), an open-source static site generator. In order to preview your guide before submission, you need to install Hugo on your local computer. This site currently uses **Hugo v0.125.7**. To remain consistent in the testing and development process, it's recommended to install this version instead of using a newer version.
The Linode documentation library is built using [Hugo](http://gohugo.io), an open-source static site generator. In order to preview your guide before submission, you need to install Hugo on your local computer. This site currently uses **Hugo v0.138.0**. To remain consistent in the testing and development process, it's recommended to install this version instead of using a newer version.

Note: If you observe any issues on a newer version, please [file an issue](https://github.com/linode/docs/issues) in the docs GitHub repository.

#### macOS and Linux

To install Hugo, download the appropriate binary for your system, extract it, and move it to a directory within your PATH.

1. Download the file below that corresponds with the OS and platform on your local system. If you don't see your system on this list, you can find additional files on the [Hugo v0.125.7 GitHub release page](https://github.com/gohugoio/hugo/releases/tag/v0.125.7) under **Assets**.
1. Download the file below that corresponds with the OS and platform on your local system. If you don't see your system on this list, you can find additional files on the [Hugo v0.138.0 GitHub release page](https://github.com/gohugoio/hugo/releases/tag/v0.138.0) under **Assets**.

- **macOS:** https://github.com/gohugoio/hugo/releases/download/v0.125.7/hugo_extended_0.125.7_darwin-universal.tar.gz
- **Linux:** https://github.com/gohugoio/hugo/releases/download/v0.125.7/hugo_extended_0.125.7_Linux-64bit.tar.gz
- **macOS:** https://github.com/gohugoio/hugo/releases/download/v0.138.0/hugo_extended_0.138.0_darwin-universal.tar.gz
- **Linux:** https://github.com/gohugoio/hugo/releases/download/v0.138.0/hugo_extended_0.138.0_Linux-64bit.tar.gz

You can download this file through a terminal using the curl command, replacing [url] with the URL for your platform:

Expand Down Expand Up @@ -115,7 +115,7 @@ To install Hugo, download the appropriate binary for your system, extract it, an

While macOS and Linux are preferred by most of the core Linode Docs team, it's also possible to use Hugo on Windows.

1. Download the [hugo_extended_0.125.7_windows-amd64.zip](https://github.com/gohugoio/hugo/releases/download/v0.125.7/hugo_extended_0.125.7_windows-amd64.zip) file. Additional files for other operating systems can be found on the [Hugo v0.125.7 GitHub release page](https://github.com/gohugoio/hugo/releases/tag/v0.125.7) under **Assets**.
1. Download the [hugo_extended_0.138.0_windows-amd64.zip](https://github.com/gohugoio/hugo/releases/download/v0.138.0/hugo_extended_0.138.0_windows-amd64.zip) file. Additional files for other operating systems can be found on the [Hugo v0.138.0 GitHub release page](https://github.com/gohugoio/hugo/releases/tag/v0.138.0) under **Assets**.

1. Extract the file to the directory you'd like to install Hugo under, such as `C:\Hugo\bin`.

Expand Down Expand Up @@ -184,10 +184,10 @@ For more information about using Git, refer to the [official Git documentation](
This section is only relevant to contributors who have previously worked on the docs repo prior to the Tailwind v3 upgrade (which occurred on July 6th, 2023 in docs release v1.252.0). After you merge in changes from this release (and onward), you will likely notice display issues when previewing the site locally. This is due to Tailwind v3 and the way it integrates with Hugo (and our theme). To complete the upgrade locally and fix any display issues, follow the steps below.
1. Upgrade Hugo to v0.125.7. On macOS, run the following commands in a temporary folder (not in your docs repo):
1. Upgrade Hugo to v0.138.0. On macOS, run the following commands in a temporary folder (not in your docs repo):
curl -OL https://github.com/gohugoio/hugo/releases/download/v0.125.7/hugo_extended_0.125.7_darwin-universal.tar.gz
tar -xvzf hugo_extended_0.125.7_darwin-universal.tar.gz
curl -OL https://github.com/gohugoio/hugo/releases/download/v0.138.0/hugo_extended_0.138.0_darwin-universal.tar.gz
tar -xvzf hugo_extended_0.138.0_darwin-universal.tar.gz
mv hugo /usr/local/bin
If you are using a different operating system, refer to the [Install Hugo](#install-hugo) section above.
Expand Down
2 changes: 1 addition & 1 deletion _vendor/github.com/linode/linode-docs-theme/config.toml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion _vendor/modules.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# github.com/linode/linode-docs-theme v0.0.0-20241107185827-f54f3d0cc486
# github.com/linode/linode-docs-theme v0.0.0-20241112191537-cb59b44a8bd6
# github.com/linode/linode-website-partials v0.0.0-20241107184419-08ebb197096e
# github.com/gohugoio/hugo-mod-jslibs-dist/alpinejs/v3 v3.21300.20800
# github.com/gohugoio/hugo-mod-jslibs/turbo/v8 v8.20000.20400
Expand Down
1 change: 1 addition & 0 deletions ci/vale/dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ ahci0
Aho
ahvz
aircrack
Aiven
ajenti
ajp
Akamai
Expand Down
2 changes: 1 addition & 1 deletion config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ anchor = "smart"
[security]
enableInlineShortcodes = false
[security.exec]
allow = ['^dart-sass-embedded$', '^go$', '^npx$', '^postcss$']
allow = ['^dart-sass-embedded$', '^go$', '^npx$', '^postcss$', '^git$']
osEnv = ['(?i)^(.*)$']

[security.funcs]
Expand Down
7 changes: 4 additions & 3 deletions docs/guides/databases/general/database-solutions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description: "Learn about the most popular database management systems and how t
authors: ["Linode"]
contributors: ["Linode"]
published: 2023-07-11
modified: 2024-11-14
keywords: ['DBMS', 'managed database']
license: '[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0)'
---
Expand Down Expand Up @@ -79,14 +80,14 @@ Many users employ provisioning tools like Terraform and configuration management

*Use Managed Databases when you want to offload database software and infrastructure management and do not require full root control or setting customization.*

The [Managed Database](/docs/products/databases/managed-databases/) service is an easy-to-use and fully-managed database solution. When a database is deployed through Managed Databases, the infrastructure, software, firewall, and high availability systems are configured automatically. This saves you time and resources. Once provisioned, you can add your application's IP addresses to allow traffic and then connect to the database directly from your application.
The [Managed Database](https://techdocs.akamai.com/cloud-computing/docs/managed-databases) service is an easy-to-use and fully-managed database solution. When a database is deployed through Managed Databases, the infrastructure, software, firewall, and high availability systems are configured automatically. This saves you time and resources. Once provisioned, you can add your application's IP addresses to allow traffic and then connect to the database directly from your application.

Managed Databases can be deployed with a single node (1 underlying machine) or a cluster of 3 nodes. Using 3 nodes provides you with a highly available database cluster, complete with data redundancy and automatic failover. Further, you can customize the size of the nodes and select from [Dedicated CPU](/docs/products/compute/compute-instances/plans/dedicated-cpu/) or [Shared CPU](/docs/products/compute/compute-instances/plans/shared-cpu/) Compute Instance plans. Since the underlying machines are fully-managed, direct root or console access is not provided and there is limited customization options for the database software.

Currently, the following databases are supported. Click on each database below to learn more and to view the available software versions.

- [MySQL](/docs/products/databases/managed-databases/guides/database-engines/#mysql)
- [PostgreSQL](/docs/products/databases/managed-databases/guides/database-engines/#postgresql)
- [MySQL](https://techdocs.akamai.com/cloud-computing/docs/mysql-managed-database)
- [PostgreSQL](https://techdocs.akamai.com/cloud-computing/docs/postgresql-managed-databases)

{{< note >}}
Updates and security patches are automatically applied to the underlying operating system but *not* to the database software. For more details, review the [Automatic Updates and Maintenance Windows](/docs/products/databases/managed-databases/guides/updates-and-maintenance/) guide.
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/databases/mysql/install-mysql/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Learn how to install MySQL on Linux (through your distribution's n
authors: ["Linode"]
contributors: ["Linode"]
published: 2022-07-01
modified: 2023-05-30
modified: 2024-11-14
keywords: ['mysql','repository','database']
tags: ['mysql']
license: '[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0)'
Expand Down Expand Up @@ -33,7 +33,7 @@ For additional instructions on installing MySQL on any supported operating syste

- **Consider other deployment options, such as fully managed solutions or automated installations.**

- [Linode MySQL Managed Databases](https://www.linode.com/products/mysql/): Fully managed database clusters, complete with automatic updates and backups, hosted on Linode's reliable platform.
- [Managed Databases](https://techdocs.akamai.com/cloud-computing/docs/managed-databases): Fully managed database clusters hosted on Akamai's reliable platform.

{{% content "dbass-eos" %}}

Expand Down
11 changes: 5 additions & 6 deletions docs/guides/databases/mysql/mysql-command-line-client/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description: "This guide shows you how to install and use the MySQL command-Line
authors: ["Linode"]
contributors: ["Linode"]
published: 2022-07-01
modified: 2024-11-14
keywords: ['mysql connect','remote database','mysql database']
tags: ['mysql']
license: '[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0)'
Expand All @@ -16,12 +17,14 @@ external_resources:
This guide shows you how to connect to a MySQL database using [mysql](https://dev.mysql.com/doc/refman/8.0/en/mysql.html), the MySQL command-line client. This opens up a simple SQL shell environment, allowing you to perform [SQL queries and commands](/docs/guides/sql-commands/) on your database. If you require more advanced capabilities, consider using the [MySQL Shell](https://dev.mysql.com/doc/mysql-shell/8.0/en/).

{{< note >}}
If you wish to connect to a Linode MySQL Managed Database, review the [Connect to a MySQL Managed Database](/docs/products/databases/managed-databases/guides/mysql-connect/) guide instead.
If you wish to connect to a MySQL Managed Database, review the [Connect to a MySQL Managed Database](https://techdocs.akamai.com/cloud-computing/docs/connect-to-a-mysql-managed-database) guide instead.
{{< /note >}}

## Before You Begin

- **Obtain the connection details for the MySQL instance you wish to use.** If you do not have a MySQL instance yet, you can [create a Managed Database](https://www.linode.com/products/mysql/), [deploy the MySQL Marketplace App](https://www.linode.com/marketplace/apps/linode/mysql-mariadb/), or [install MySQL server (or MariaDB) on a Compute Instance](/docs/guides/install-mysql/). **This instance must allow remote connections or you must run the mysql command from within same system.**
- **Obtain the connection details for the MySQL instance you wish to use.** If you do not have a MySQL instance yet, you can [create a Managed Database](https://techdocs.akamai.com/cloud-computing/docs/managed-databases), [deploy the MySQL Marketplace App](https://www.linode.com/marketplace/apps/linode/mysql-mariadb/), or [install MySQL server (or MariaDB) on a Compute Instance](/docs/guides/install-mysql/). **This instance must allow remote connections or you must run the mysql command from within same system.**

{{% content "dbass-eos" %}}

- **Ensure mysql is installed and is compatible with the MySQL version on your database server.** Run the following command on the system you intend on using to verify that mysql is installed.

Expand All @@ -45,10 +48,6 @@ The main purpose of the mysql utility is to connect to a MySQL database server a

mysql -h [host] -p [port] -u [username] -p

{{< note respectIndent=false >}}
If you wish to connect to a Linode MySQL Managed Database, review the [Connect to a MySQL Managed Database](/docs/products/databases/managed-databases/guides/mysql-connect/) guide instead.
{{< /note >}}

## Common Command Options

The following list is a collection of common options used with the mysqldump command. At minimum, the username and password is required. When connecting to a remote database server, the host (and perhaps the port) should be provided. For a full list of available options, reference the [Command Options for Connecting to the Server](https://dev.mysql.com/doc/refman/8.0/en/connection-options.html) documentation.
Expand Down
10 changes: 5 additions & 5 deletions docs/guides/databases/mysql/mysqldump-backups/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Learn how to use mysqldump to back up MySQL (and MariaDB) database
authors: ["Linode"]
contributors: ["Linode"]
published: 2018-01-30
modified: 2022-07-01
modified: 2024-11-14
keywords: ["mysql", "mariadb", "backup", "back up", "mysqldump"]
license: '[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0)'
aliases: ['/databases/mysql/backup-options/','/security/backups/back-up-your-mysql-databases/','/databases/mysql/back-up-your-mysql-databases/','/databases/mysql/use-mysqldump-to-back-up-mysql-or-mariadb/','/guides/use-mysqldump-to-back-up-mysql-or-mariadb/']
Expand All @@ -24,7 +24,7 @@ Since the mysqldump utility needs to connect to the database, the database manag

## Before You Begin

- **Obtain the connection details for the MySQL instance you wish to use.** If you do not have a MySQL instance yet, you can [create a Managed Database](https://www.linode.com/products/mysql/), [deploy the MySQL Marketplace App](https://www.linode.com/marketplace/apps/linode/mysql-mariadb/), or [install MySQL server (or MariaDB) on a Compute Instance](/docs/guides/install-mysql/).
- **Obtain the connection details for the MySQL instance you wish to use.** If you do not have a MySQL instance yet, you can [create a Managed Database](https://techdocs.akamai.com/cloud-computing/docs/managed-databases), [deploy the MySQL Marketplace App](https://www.linode.com/marketplace/apps/linode/mysql-mariadb/), or [install MySQL server (or MariaDB) on a Compute Instance](/docs/guides/install-mysql/).

{{% content "dbass-eos" %}}

Expand Down Expand Up @@ -57,7 +57,7 @@ The following list represents mysqldump commands for various scenarios. Within t
mysqldump [options] --all-databases > backup.sql

{{< note type="alert" respectIndent=false >}}
Do not use the `--all-databases` option if you intend on restoring this database to a Linode MySQL Managed Database. It may delete existing users and restrict access to your database.
Do not use the `--all-databases` option if you intend on restoring this database to a MySQL Managed Database. It may delete existing users and restrict access to your database.
{{< /note >}}

{{< note >}}
Expand All @@ -69,7 +69,7 @@ Depending on the size of the database, it could take a while to complete. For la
The following list is a collection of common options used with the mysqldump command. At minimum, the username and password is required. When connecting to a remote database server, the host (and perhaps the port) should be provided. For a full list of available options, reference the [Option Syntax](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html#mysqldump-option-summary) documentation.

{{< note >}}
When backing up a Linode MySQL [Managed Database](/docs/products/databases/managed-databases/) with mysqldump, review the [Connect to a MySQL Managed Database](/docs/products/databases/managed-databases/guides/mysql-connect/) guide for instructions on viewing the connection details (including the username, password, host, and port).
When backing up a MySQL [Managed Database](https://techdocs.akamai.com/cloud-computing/docs/managed-databases) with mysqldump, review the [Connect to a MySQL Managed Database](https://techdocs.akamai.com/cloud-computing/docs/connect-to-a-mysql-managed-database) guide for instructions on viewing the connection details (including the username, password, host, and port).
{{< /note >}}

- **Username** (`--user=[]` or `-u []`): The username of your MySQL user. This user must have proper grants to access the database.
Expand Down Expand Up @@ -102,7 +102,7 @@ If you are frequently backing up a database with mysqldump or running a backup t

mysqldump -h 192.0.2.1 -u exampleuser -p --single-transaction SampleDatabase > backup-$(date +%F).sql

- **Single database on a *Linode MySQL* [***Managed Database***](/docs/products/databases/managed-databases/):** In this example, the mysqldump command is used to backup a database called *Test* in a Linode MySQL Managed Database cluster. See [Connect to a MySQL Managed Database](/docs/products/databases/managed-databases/guides/mysql-connect/) guide for instructions on viewing the connection details (including the username, password, host, and port).
- **Single database on a *MySQL* [***Managed Database***](https://techdocs.akamai.com/cloud-computing/docs/managed-databases):** In this example, the mysqldump command is used to backup a database called *Test* in a MySQL Managed Database cluster. See [Connect to a MySQL Managed Database](https://techdocs.akamai.com/cloud-computing/docs/connect-to-a-mysql-managed-database) guide for instructions on viewing the connection details (including the username, password, host, and port).

mysqldump -h lin-1111-1111-mysql-primary.servers.linodedb.net -u linroot -p --single-transaction --set-gtid-purged=OFF Test > backup-$(date +%F-%H.%M.%S).sql

Expand Down
Loading

0 comments on commit c938f1d

Please sign in to comment.