Using Go 1.21.0 Toolset
Installing and using Go 1.21.0 Toolset
Abstract
Making open source more inclusive Copy linkLink copied to clipboard!
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright’s message.
Providing feedback on Red Hat documentation Copy linkLink copied to clipboard!
We appreciate your feedback on our documentation. Let us know how we can improve it.
Submitting feedback through Jira (account required)
- Log in to the Jira website.
- Click Create in the top navigation bar
- Enter a descriptive title in the Summary field.
- Enter your suggestion for improvement in the Description field. Include links to the relevant parts of the documentation.
- Click Create at the bottom of the dialogue.
Chapter 1. Go Toolset Copy linkLink copied to clipboard!
Go Toolset is a Red Hat offering for developers on Red Hat Enterprise Linux (RHEL). It provides the Go programming language tools and libraries. Note that Go is alternatively known as golang.
Go Toolset is available as a module for Red Hat Enterprise Linux 8. Go Toolset is available as packages for Red Hat Enterprise Linux 9.
1.1. Go Toolset components Copy linkLink copied to clipboard!
The following components are available as a part of Go Toolset:
Name | Version | Description |
---|---|---|
golang | RHEL 8 — 1.21.0, RHEL 9 — 1.21.0 | A Go compiler. |
delve | RHEL 8 — 1.21.0, RHEL 9 — 1.21.0 | A Go debugger. |
1.2. Go Toolset compatibility Copy linkLink copied to clipboard!
Go Toolset is available for Red Hat Enterprise Linux 8 and Red Hat Enterprise Linux 9 on the following architectures:
- AMD and Intel 64-bit
- 64-bit ARM
- IBM Power Systems, Little Endian
- 64-bit IBM Z
1.3. Installing Go Toolset Copy linkLink copied to clipboard!
Complete the following steps to install Go Toolset, including all dependent packages.
Prerequisites
- All available Red Hat Enterprise Linux updates are installed.
Procedure
On Red Hat Enterprise Linux 8, install the go-toolset
module by running:
yum module install go-toolset
# yum module install go-toolset
On Red Hat Enterprise Linux 9, install the go-toolset
package by running:
dnf install go-toolset
# dnf install go-toolset
1.4. Installing Go documentation Copy linkLink copied to clipboard!
You can install documentation for the Go programming language on your local system.
Prerequisites
-
Go Toolset is installed.
For more information, see Installing Go Toolset.
Procedure
To install the golang-docs
package, run the following command:
On Red Hat Enterprise Linux 8:
yum install golang-docs
# yum install golang-docs
Copy to Clipboard Copied! Toggle word wrap Toggle overflow You can find the documentation under the following path:
/usr/lib/golang/doc/go_spec.html
.On Red Hat Enterprise Linux 9:
dnf install golang-docs
# dnf install golang-docs
Copy to Clipboard Copied! Toggle word wrap Toggle overflow You can find the documentation under the following path:
/usr/lib/golang/doc/go_spec.html
.
Chapter 2. The Go compiler Copy linkLink copied to clipboard!
The Go compiler is a build tool and dependency manager for the Go programming language. It offers error checking and optimization of your code.
2.1. Prerequisites Copy linkLink copied to clipboard!
-
Go Toolset is installed.
For more information, see Installing Go Toolset.
2.2. Setting up a Go workspace Copy linkLink copied to clipboard!
To compile a Go program, you need to set up a Go workspace.
Procedure
Create a workspace directory as a subdirectory of
$GOPATH/src
.A common choice is
$HOME/go
.- Place your source files into your workspace directory.
Set the location of your workspace directory as an environment variable to the
$HOME/.bashrc
file by running:echo 'export GOPATH=<workspace_dir>' >> $HOME/.bashrc source $HOME/.bashrc
$ echo 'export GOPATH=<workspace_dir>' >> $HOME/.bashrc $ source $HOME/.bashrc
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Replace <workspace_dir> with the name of your workspace directory.
2.3. Compiling a Go program Copy linkLink copied to clipboard!
You can compile your Go program using the Go compiler. The Go compiler creates an executable binary file as a result of compiling.
Prerequisites
-
A set up Go workspace with configured modules.
For information on how to set up a workspace, see Setting up a Go workspace.
Procedure
In your project directory, run:
On Red Hat Enterprise Linux 8:
go build <output_file> <go_main_package>
$ go build <output_file> <go_main_package><go_main_package><go_main_package>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<output_file>
with the desired name of your output file and<go_main_package>
with the name of your main package.
-
Replace
On Red Hat Enterprise Linux 9:
go build <output_file> <go_main_package>
$ go build <output_file> <go_main_package><go_main_package><go_main_package>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<output_file>
with the desired name of your output file and<go_main_package>
with the name of your main package.
-
Replace
2.4. Running a Go program Copy linkLink copied to clipboard!
The Go compiler creates an executable binary file as a result of compiling. Complete the following steps to execute this file and run your program.
Prerequisites
-
Your program is compiled.
For more information on how to compile your program, see Compiling a Go program.
Procedure
To run your program, run in the directory containing the executable file:
./<file_name>
$ ./<file_name>
-
Replace
<file_name>
with the name of your executable file.
2.5. Installing compiled Go projects Copy linkLink copied to clipboard!
You can install already compiled Go projects to use their executable files and libraries in further Go projects. After installation, the executable files and libraries of the project are copied to according directories in the Go workspace. Its dependencies are installed as well.
Prerequisites
-
A Go workspace with configured modules.
For more information, see Setting up a Go workspace.
Procedure
To install a Go project, run:
On Red Hat Enterprise Linux 8:
go install <go_project>
$ go install <go_project>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<go_project>
with the name of the Go project you want to install.
-
Replace
On Red Hat Enterprise Linux 9:
go install <go_project>
$ go install <go_project>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<go_project>
with the name of the Go project you want to install.
-
Replace
2.6. Downloading and installing Go projects Copy linkLink copied to clipboard!
You can download and install third-party Go projects from online resources to use their executable files and libraries in further Go projects. After installation, the executable files and libraries of the project are copied to according directories in the Go workspace. Its dependencies are installed as well.
Prerequisites
-
A Go workspace.
For more information, see Setting up a Go workspace.
Procedure
To download and install a Go project, run:
On Red Hat Enterprise Linux 8:
go install <third_party_go_project>
$ go install <third_party_go_project>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<third_party_go_project>
with the name of the project you want to download.
-
Replace
On Red Hat Enterprise Linux 9:
go install <third_party_go_project>
$ go install <third_party_go_project>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<third_party_go_project>
with the name of the project you want to download.
-
Replace
For information on possible values of third-party projects, run:
On Red Hat Enterprise Linux 8:
go help importpath
$ go help importpath
Copy to Clipboard Copied! Toggle word wrap Toggle overflow On Red Hat Enterprise Linux 9:
go help importpath
$ go help importpath
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Chapter 3. The gofmt formatting tool Copy linkLink copied to clipboard!
Instead of a style guide, the Go programming language uses the gofmt
code formatting tool. gofmt
automatically formats your code according to the Go layout rules.
3.1. Prerequisites Copy linkLink copied to clipboard!
-
Go Toolset is installed.
For more information, see Installing Go Toolset.
3.2. Formatting code Copy linkLink copied to clipboard!
You can use the gofmt
formatting tool to format code in a given path. When the path leads to a single file, the changes apply only to the file. When the path leads to a directory, all .go
files in the directory are processed.
Procedure
To format your code in a given path, run:
On Red Hat Enterprise Linux 8:
gofmt -w <code_path>
$ gofmt -w <code_path>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<code_path>
with the path to the code you want to format.
-
Replace
On Red Hat Enterprise Linux 9:
gofmt -w <code_path>
$ gofmt -w <code_path>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<code_path>
with the path to the code you want to format.
-
Replace
To print the formatted code to standard output instead of writing it to the original file, omit the -w
option.
3.3. Previewing changes to code Copy linkLink copied to clipboard!
You can use the gofmt
formatting tool to preview changes done by formatting code in a given path. The output in unified diff format is printed to standard output.
Procedure
To show differences in your code in a given path, run:
On Red Hat Enterprise Linux 8:
gofmt -d <code_path>
$ gofmt -d <code_path>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<code_path>
with the path to the code you want to compare.
-
Replace
On Red Hat Enterprise Linux 9:
gofmt -d <code_path>
$ gofmt -d <code_path>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<code_path>
with the path to the code you want to compare.
-
Replace
3.4. Simplifying code Copy linkLink copied to clipboard!
You can use the gofmt
formatting tool to simplify your code.
Procedure
To simplify code in a given path, run:
On Red Hat Enterprise Linux 8:
gofmt -s -w <code_path>
$ gofmt -s -w <code_path>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<code_path>
with the path to the code you want to simplify.
-
Replace
On Red Hat Enterprise Linux 9:
gofmt -s -w <code_path>
$ gofmt -s -w <code_path>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<code_path>
with the path to the code you want to simplify.
-
Replace
To apply the changes, run:
On Red Hat Enterprise Linux 8:
gofmt -w <code_path>
$ gofmt -w <code_path>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<code_path>
with the path to the code you want to format.
-
Replace
On Red Hat Enterprise Linux 9:
gofmt -w <code_path>
$ gofmt -w <code_path>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<code_path>
with the path to the code you want to format.
-
Replace
3.5. Refactoring code Copy linkLink copied to clipboard!
You can use the gofmt
formatting tool to refactor your code by applying arbitrary substitutions.
Procedure
To refactor your code in a given path, run:
On Red Hat Enterprise Linux 8:
gofmt -r -w <rewrite_rule> <code_path>
$ gofmt -r -w <rewrite_rule> <code_path>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<code_path>
with the path to the code you want to refactor and<rewrite_rule>
with the rule you want it to be rewritten by.
-
Replace
On Red Hat Enterprise Linux 9:
gofmt -r -w <rewrite_rule> <code_path>
$ gofmt -r -w <rewrite_rule> <code_path>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<code_path>
with the path to the code you want to refactor and<rewrite_rule>
with the rule you want it to be rewritten by.
-
Replace
To apply the changes, run:
On Red Hat Enterprise Linux 8:
gofmt -w <code_path>
$ gofmt -w <code_path>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<code_path>
with the path to the code you want to format.
-
Replace
On Red Hat Enterprise Linux 9:
gofmt -w <code_path>
$ gofmt -w <code_path>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<code_path>
with the path to the code you want to format.
-
Replace
Chapter 4. The Go race detector Copy linkLink copied to clipboard!
Go Toolset includes the Go race detector, which is a tool of the Go standard library for finding race conditions.
Note that the race detector has a significant runtime resource overhead.
4.1. Prerequisites Copy linkLink copied to clipboard!
-
Go Toolset is installed.
For more information, see Installing Go Toolset.
4.2. Using the Go race detector Copy linkLink copied to clipboard!
Use the Go race detector to check your code for race conditions.
Procedure
To use the race detector, run:
On Red Hat Enterprise Linux 8:
go build -race -o <output_file> <go_main_package>
$ go build -race -o <output_file> <go_main_package>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<output_file>
with the name of your executable file and<go_main_package>
with the name of the package you want to test.
-
Replace
On Red Hat Enterprise Linux 9:
go build -race -o <output_file> <go_main_package>
$ go build -race -o <output_file> <go_main_package>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<output_file>
with the name of your executable file and<go_main_package>
with the name of the package you want to test.
-
Replace
Chapter 5. Container images with Go Toolset Copy linkLink copied to clipboard!
You can build your own Go Toolset containers from either Red Hat Enterprise Linux container images or Red Hat Universal Base Images (UBI).
5.1. Red Hat Enterprise Linux Go Toolset container images contents Copy linkLink copied to clipboard!
The Red Hat Enterprise Linux 8 and Red Hat Enterprise Linux 9 container images of Go Toolset contain the following packages:
Component | Version | Package |
---|---|---|
| 1.21 | RHEL 8 — go-toolset-1.21.0 RHEL 9 — go-toolset-1.21.0 |
5.2. Accessing Red Hat Enterprise Linux container images Copy linkLink copied to clipboard!
Pull the container image from the Red Hat registry before running your container and performing actions.
Procedure
To pull the required image, run:
For an image based on Red Hat Enterprise Linux 8:
podman pull registry.redhat.io/rhel8/go-toolset
# podman pull registry.redhat.io/rhel8/go-toolset
Copy to Clipboard Copied! Toggle word wrap Toggle overflow For an image based on Red Hat Enterprise Linux 9:
podman pull registry.redhat.io/rhel9/go-toolset
# podman pull registry.redhat.io/rhel9/go-toolset
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.3. Accessing the UBI Go Toolset container image on RHEL 8 Copy linkLink copied to clipboard!
On RHEL 8, install the UBI Go Toolset container image to access Go Toolset.
Alternatively, you can install Go Toolset to the RHEL 8 base UBI container image. For further information, see Accessing Go Toolset from the base UBI container image on RHEL 8.
Procedure
To pull the UBI Go Toolset container image from the Red Hat registry, run:
On Red Hat Enterprise Linux 8
podman pull registry.access.redhat.com/ubi8/go-toolset
# podman pull registry.access.redhat.com/ubi8/go-toolset
Copy to Clipboard Copied! Toggle word wrap Toggle overflow On Red Hat Enterprise Linux 9
podman pull registry.access.redhat.com/ubi9/go-toolset
# podman pull registry.access.redhat.com/ubi9/go-toolset
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.4. Accessing Go Toolset from the base UBI container image on RHEL 8 Copy linkLink copied to clipboard!
On RHEL 8, Go Toolset packages are part of the Red Hat Universal Base Images (UBIs) repositories, which means you can install Go Toolset as an addition to the base UBI container image. To keep the container image size small, install only individual packages instead of the entire Go Toolset.
Alternatively, you can install the UBI Go Toolset container image to access Go Toolset. For further information, see Accessing the UBI Go Toolset container image on RHEL 8.
Prerequisites
-
An existing Containerfile.
For information on creating Containerfiles, see the Dockerfile reference page.
Procedure
- To create a container image containing Go Toolset, add the following lines to your Containerfile:
FROM registry.access.redhat.com/ubi8/ubi:latest RUN yum module install -y go-toolset
FROM registry.access.redhat.com/ubi8/ubi:latest
RUN yum module install -y go-toolset
To create a container image containing an individual package only, add the following lines to your Containerfile:
RUN yum install -y <package-name>
RUN yum install -y <package-name>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Replace
<package-name>
with the name of the package you want to install.
-
Replace
Chapter 6. Changes in Go Toolset Copy linkLink copied to clipboard!
Go Toolset has been updated from version 1.20 to 1.21.0 on RHEL 8 and RHEL 9.
Notable changes include:
-
min
,max
, andclear
built-ins have been added. - Package initialization order is more precisely defined.
- Type inferencing is improved.
- Changes to loop variable semantics.
- Backwards compatibility support is improved.