Skip to content

Commit 954174c

Browse files
stevsmitSteven Smith
and
Steven Smith
authored
Small edits to troubleshooting guide (#734)
Co-authored-by: Steven Smith <[email protected]>
1 parent b09124f commit 954174c

29 files changed

+75
-41
lines changed

.vale.ini

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
StylesPath = styles
2+
3+
MinAlertLevel = suggestion
4+
5+
Packages = RedHat
6+
7+
[*]
8+
BasedOnStyles = RedHat
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Regex terms added to accept.txt are ignored by the Vale linter and override RedHat Vale rules.
2+
# Add terms that have a corresponding incorrectly capitalized form to reject.txt.
3+
4+
[Pp]assthrough
5+
Assisted Installer
6+
Control Plane Machine Set Operator
7+
custom resource
8+
custom resources
9+
MetalLB
10+
Operator
11+
Operators
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Regex terms added to reject.txt are highlighted as errors by the Vale linter and override RedHat Vale rules.
2+
# Add terms that have a corresponding correctly capitalized form to accept.txt.
3+
4+
[Dd]eployment [Cc]onfigs?
5+
[Dd]eployment [Cc]onfigurations?
6+
[Oo]peratorize
7+
[Ss]ingle [Nn]ode OpenShift
8+
[Tt]hree [Nn]ode OpenShift
9+
AI
10+
configuration maps?
11+
MachineSets
12+
machinesets?
13+
minions?
14+
operators?
15+
SNO

modules/authentication-troubleshooting.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ The following authentication methods are supported by {productname}:
1414
1515
* *Token-based authentication*. Users can obtain unique tokens that grant access to specific resources within {productname}. Tokens can be obtained through various means, such as OAuth or by generating API tokens within the {productname} user interface. Token-based authentication is often used for automated or programmatic access to the registry.
1616
17-
* *External identity provider*. {productname} can integrate with external identity providers, such as LDAP or AzureAD, for authentication purposes. This integration allows organizations to leverage their existing identity management infrastructure, enabling centralized user authentication and reducing the need for separate user databases.
17+
* *External identity provider*. {productname} can integrate with external identity providers, such as LDAP or AzureAD, for authentication purposes. This integration allows organizations to use their existing identity management infrastructure, enabling centralized user authentication and reducing the need for separate user databases.

modules/build-logs-not-loading.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
[id="build-logs-not-loading"]
33
= Build logs are not loading
44

5-
In some cases, attempting to load logs for a repository build results in only a throbber, and no logs are displayed. This typically occurs when you are using a browser equipped with one of the following extensions: AdBlock, uBlock, or Privacy Badger. These browser extensions can cause the loading of build logs to be cancelled. To resolve this issue, disable the browser extension and reload the page.
5+
In some cases, attempting to load logs for a repository build results in only a throbber icon, and no logs are displayed. This typically occurs when you are using a browser equipped with one of the following extensions: AdBlock, uBlock, or Privacy Badger. These browser extensions can cause the loading of build logs to be cancelled. To resolve this issue, disable the browser extension and reload the page.

modules/build-trigger-error.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:_content-type: CONCEPT
22
[id="build-trigger-error"]
3-
= Unable to add a Build Trigger
3+
= Unable to add a build trigger
44

5-
In some cases, attempting to add a Build Trigger results in the following error message: `You are not admin on the SCM repository`. In order for {productname} to add the webhook callback necessary for Build Triggers, the user granting {productname} access to the SCM repository must have administrative access on that repository.
5+
In some cases, attempting to add a build trigger results in the following error message: `You are not admin on the SCM repository`. In order for {productname} to add the webhook callback necessary for Build Triggers, the user granting {productname} access to the SCM repository must have administrative access on that repository.

modules/cannot-access-private-repo.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[id="cannot-access-private-repo"]
33
= Unable to access private repositories using Amazon EC2 Container Service
44

5-
In some cases, authentication fails while attempting to use Amazon Elastic Container Service (EC2). This error occurs when the authentication configuration in the `ecs.config` file is missing.
5+
In some cases, authentication fails while attempting to use Amazon Elastic Container Service (ECS). This error occurs when the authentication configuration in the `ecs.config` file is missing.
66

77
In order for ECS to pull down Docker images, the following information must be included in the ECS configuration file that is located in the `/etc/ecs/ecs.conf` file:
88

modules/cannot-locate-dockerfile.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ When building an image, the following error is returned: `A build step failed: A
66

77
* *The `.dockerignore` file contains the Dockerfile.* Unlike Docker Hub, the Dockerfile is part of the Build Context on {productname}. The Dockerfile must not appear in the `.dockerignore` file. Remove the Dockerfile from the `.dockerignore` file to resolve the issue.
88
9-
* *The Build Trigger is incorrect.* Verify the Dockerfile location and the branch/tag value specified in the Build Trigger.
9+
* *The build trigger is incorrect.* Verify the Dockerfile location and the branch or tag value specified in the build trigger.

modules/cannot-reach-registry-endpoint.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
[id="cannot-reach-registry-endpoint"]
33
= Unable to reach registry endpoint
44

5-
In some cases, attempting to pull a Docker image returns the following error: `Could not reach any registry endpoint`. This usually occurs because you are attempting to pull a non-existent tag. If you do not specify a tag, newer version of Docker attempt to pull the "latest" tag, regardless of whether it actually exists.
5+
In some cases, trying to pull a Docker image returns the following error: `Could not reach any registry endpoint`. This usually occurs because you are attempting to pull a non-existent tag. If you do not specify a tag, newer version of Docker attempt to pull the "latest" tag, regardless of whether it actually exists.
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:_content-type: CONCEPT
22
[id="clair-distroless-container-images"]
3-
= Does Clair supporting scanning of distoless container images?
3+
= Does Clair supporting scanning of disto-less container images?
44

5-
Support for scanning distroless containers was added in Clair 4.6.1. This feature is not present in earlier versions. For Clair on the {productname} Operator, this feature was released with {productname} 3.8.7.
5+
Support for scanning distro-less containers was added in Clair 4.6.1. This feature is not present in earlier versions. For Clair on the {productname} Operator, this feature was released with {productname} 3.8.7.

modules/clair-troubleshooting-issues.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ $ podman logs clair-container
112112
[id="updating-cve-database"]
113113
== Updating the CVE database
114114

115-
Updating the CVE database can be a memory and CPU intensive task, especially if there are several CVEs that must be parsed. If the resources are exhausted during this process, the system kernel can terminate the offending process. This should be visible in Docker logs, Podman logs, or in the system journal. For example:
115+
Updating the CVE database can be a memory and CPU intensive task, especially if there are several CVEs that must be parsed. If the resources are exhausted during this process, the system kernel can stop the offending process. This should be visible in Docker logs, Podman logs, or in the system journal. For example:
116116

117117
[source,terminal]
118118
----

modules/connecting-s3-timeout.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ In some cases, {productname} attempts to connect to the s3 bucket that is descri
66

77
This error occurs because the URL format of a bucket is one of two options. For example:
88

9-
* `http://s3.amazonaws.com/[bucket_name]/`
9+
* `\http://s3.amazonaws.com/[bucket_name]/`
1010
* `http://[bucket_name].s3.amazonaws.com/`
1111
1212
To resolve this issue, you must add the `s3_region` configuration parameter to your `config.yaml` file. This field is not currently embedded in the {productname} config editor, so it must be manually added. If this field is not present in your `config.yaml` file, the Authorization header explicitly mentions a different region and not the region set in the `hostname` field of your `config.yaml` file.

modules/database-troubleshooting-issues.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ $ podman stats <container_name>
316316
postgres=# \l+
317317
----
318318

319-
. Enter the following command to connect with the PostgreSQL database:
319+
. Enter the following command to connect to the PostgreSQL database:
320320
+
321321
[source,terminal]
322322
----

modules/deleting-user-cli.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_content-type: CONCEPT
22
[id="deleting-user-cli"]
3-
= Deleting a user from {productname} from the command line
3+
= Deleting a {productname} user from the command line
44

55
When accessing the *Users* tab in the *Superuser Admin* panel of the {productname} UI, you might encounter a situation where no users are listed. Instead, a message appears, indicating that {productname} is configured to use external authentication, and users can only be created in that system.
66

modules/docker-failing-pulls.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
In some cases, using `docker pull` might return the following error: `39cb5a2eab5d: Error pulling image (myimage) from quay.io/my/repository. . . Could not find repository on any of the indexed registries.` There are two reasons for receiving this error.
66

7-
* *Linux kernel bug on Ubuntu Precise Pangolin (12.04 LTS) (64-bit).* Precise has a Linux kernel bug that must be updated in order to use Docker. Use the following commands to update and reboot Precise.
7+
* *Linux kernel bug on Ubuntu Precise Pangolin (12.04 LTS) (64-bit).* Precise has a Linux kernel bug that must be updated to use Docker. Use the following commands to update and reboot Precise.
88
+
99
[source,terminal]
1010
----
@@ -21,7 +21,7 @@ $ sudo apt-get install linux-image-generic-lts-raring linux-headers-generic-lts-
2121
$ sudo reboot
2222
----
2323
24-
* *Missing AUFS on Raring 13.04 and Saucy 13.10 (64-bit).* Not all installations of Ubuntu 13.04/13.10 ship with AUFS enabled. Enter the following commands to install additional Linux kernel modules:
24+
* *Missing AUFS on Raring 13.04 and Saucy 13.10 (64-bit).* Not all installations of Ubuntu 13.04 or 13.10 include AUFS enabled. Enter the following commands to install additional Linux kernel modules:
2525
+
2626
[source,terminal]
2727
----

modules/error-403-troubleshooting.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ For more information, see link:https://github.com/moby/moby/issues/4267[Dockercf
2727

2828
Docker stores the credentials that it uses for pushing and pulling in a file that is usually placed in the `$HOME/.docker/config.json` folder. If you are executing Docker in another environment, such as a scripted `docker build`, a virtual machine, `makefile`, `virtualenv`, and so on, Docker cannot find the `config.json` file and fails.
2929

30-
As a workaround, make sure that the `config.json` file is accessible to the environment which is performing the push or pull commands.
30+
As a workaround, verify that the `config.json` file is accessible to the environment which is performing the push or pull commands.
3131

3232
[id="repository-permissions"]
3333
== Insufficient repository permissions
3434

35-
Ensure that your user, robot account, or token has sufficient permissions on the repository. Permissions on a repository can be edited from the *Settings* -> *Repository settings* page.
35+
Ensure that your user, robot account, or token has the necessary permissions on the repository. Permissions on a repository can be edited from the *Settings* -> *Repository settings* page.
3636

3737
[NOTE]
3838
====

modules/error-429-troubleshooting.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ HTTP status code `429` indicates that the user has sent too many requests in a g
66

77
* Reduce the frequency or pace at which you are sending requests to your {productname} registry. This helps ensure that you stay within the allowed limits and avoid triggering a `429` response.
88
9-
* Implement a backoff strategy to wait and retry the request after a certain period of time. Backoff strategies involve increasing the waiting time between subsequent requests. This gives the server enough time to process previous requests, which avoids overwhelming the server.
9+
* Implement a back-off strategy to wait and retry the request after a certain period of time. Back-off strategies involve increasing the waiting time between subsequent requests. This gives the server enough time to process previous requests, which avoids overwhelming the server.
1010
11-
* Utilize caching mechanisms to store and reuse frequently accessed data from the {productname} registry. This can help reduce the need for repeated requests and improve overall performance.
11+
* Use caching mechanisms to store and reuse frequently accessed data from the {productname} registry. This can help reduce the need for repeated requests and improve overall performance.

modules/error-500-troubleshooting.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ To resolve this issue, you can increase the database connection count by using t
1212

1313
. Navigate to your `/var/lib/pgsql/data/postgresql.conf` file.
1414

15-
. Increase the database connection count by updating the the `max_connections` variable. It is recommended to set the number of connections on the database to at least `1000` for a development cluster, and `2000` for a production cluster. In some cases you might need more. For example:
15+
. Increase the database connection count by updating the `max_connections` variable. It is recommended to set the number of connections on the database to at least `1000` for a development cluster, and `2000` for a production cluster. In some cases you might need more. For example:
1616
+
1717
[source,yaml]
1818
----

modules/error-502-troubleshooting.adoc

+7-7
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ If you run {productname} in debug mode and the error `peewee.DataError: integer
4343

4444
.Procedure
4545

46-
* In most cases, a {productname} administrator can resolve this error by setting the `FEATURE_CHANGE_TAG_EXPIRATION` configuration field to `false` in their `config.yaml` file.
46+
. In most cases, a {productname} administrator can resolve this error by setting the `FEATURE_CHANGE_TAG_EXPIRATION` configuration field to `false` in their `config.yaml` file.
4747
+
4848
[NOTE]
4949
====
5050
This change affects all users of your organization and disables them from setting tag expirations themselves.
5151
====
5252

53-
* Alternatively, you can request the user or owner of the repository in question to either remove, or change, the tag expiration manually. If they do not respond, you can execute the following steps:
53+
. Alternatively, you can request the user or owner of the repository in question to either remove, or change, the tag expiration manually. If they do not respond, you can execute the following steps:
5454
+
5555
** Obtain information from the user table:
5656
+
@@ -76,11 +76,11 @@ If you are using an earlier version of {productname}, the error occurs because t
7676
[id="troubleshooting-502-push"]
7777
== Troubleshooting 502 Podman push errors
7878

79-
In some cases, the following error might be returned when using `podman push`: `Error: Error writing blob: Error initiating layer upload to /v2/repo/image/blobs/uploads/ in <registry>: received unexpected HTTP status: 502 Bad Gateway`. This issue is caused by either the Noobaa certificate rotation, or the service signing root CA rotation. The workaround for this issue is to manually add a new certificate chain to {productname}'s deployment after it has rotated.
79+
In some cases, the following error might be returned when using `podman push`: `Error: Error writing blob: Error initiating layer upload to /v2/repo/image/blobs/uploads/ in <registry>: received unexpected HTTP status: 502 Bad Gateway`. This issue is caused by either the NooBaa certificate rotation, or the service signing root CA rotation. The workaround for this issue is to manually add a new certificate chain to {productname}'s deployment after it has rotated.
8080

8181
.Procedure
8282

83-
. Download the new certificate chain for your Noobaa endpoint by entering the following command:
83+
. Download the new certificate chain for your NooBaa endpoint by entering the following command:
8484
+
8585
[source,terminal]
8686
----
@@ -121,7 +121,7 @@ For more information about this issue, see link:https://issues.redhat.com/browse
121121
[id="troubleshooting-502-unmanaged-storage"]
122122
== Troubleshooting 502 errors when using unmanaged storage
123123

124-
In some cases, pulling an image from a {productname} registry that is using RadosGW or Noobaa as an unamanged object storage returns the following error: `parsing image configuration 502 (Bad Gateway):`. Use the following steps to resolve this issue.
124+
In some cases, pulling an image from a {productname} registry that is using RadosGW or Noobaa as an unmanaged object storage returns the following error: `parsing image configuration 502 (Bad Gateway):`. Use the following steps to resolve this issue.
125125

126126
.Procedure
127127

@@ -145,7 +145,7 @@ DISTRIBUTED_STORAGE_PREFERENCE:
145145
- radosGWStorage
146146
----
147147

148-
.. If you are using Noobaa storage:
148+
.. If you are using NooBaa storage:
149149
+
150150
[source,yaml]
151151
----
@@ -164,4 +164,4 @@ DISTRIBUTED_STORAGE_PREFERENCE:
164164
- default
165165
----
166166
+
167-
With these updates, you should be able to successfully pull images when using unmanaged object storage.
167+
With these updates, you can successfully pull images when using unmanaged object storage.

modules/java-image-scan-not-working.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Use the following procedure to disable Java scanning from Clair.
1010

1111
.Procedure
1212

13-
. Check which SHA ID errors out by reaching out to the Java/Maven indexer, for example:
13+
. Check which SHA ID errors out by reaching out to the Maven indexer, for example:
1414
+
1515
[source,terminal]
1616
----
@@ -33,14 +33,14 @@ namespace | repo_name | sha_digest
3333
redhat | quay | sha256:0cea90e4778f9241c20421d8c97a8d182fd0fa51e6c84210dc4b57522fc901b8
3434
----
3535

36-
. Run the following command to find the base OS of the image, assuming it is Java-based:
36+
. Run the following command to find the base operating system of the image, assuming it is Java-based:
3737
+
3838
[source,terminal]
3939
----
4040
$ podman run image:tag /bin/bash -c "cat /etc/*release"
4141
----
4242
43-
. There are no documented steps to stop the Java/Maven indexer. Run the following command in a development or test cluster first, setting the API request to a page that returns a `404` so that it fails quickly:
43+
. There are no documented steps to stop the Maven indexer. Run the following command in a development or test cluster first, setting the API request to a page that returns a `404` so that it fails quickly:
4444
+
4545
[source,yaml]
4646
----

modules/marathon-mesos-fail.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ drwx------ root/root 0 2015-07-28 02:54 .docker/
8787
-rw------- root/root 114 2015-07-28 01:31 .docker/config.json
8888
----
8989

90-
. Optional. Put the tarball into a directory readably by Mesos:
90+
. Optional. Put the `.tar` file into a directory readably by Mesos:
9191
+
9292
[source,terminal]
9393
----

modules/missing-runc-files.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ When attempting to start containers using the Podman client tool, users encounte
66

77
The cause of this issue is the absence of required `runc` files in the older version of Podman. These missing files prevent the proper execution of containers, resulting in the encountered error. Updating Podman ensures that the necessary runc files are present, enabling the successful deployment of containers.
88

9-
To resolve this issue, it is recommended to update the Podman version in order to obtain the updated `runc` files. By updating Podman, the missing runc files will be installed, allowing containers to be deployed successfully.
9+
To resolve this issue, it is recommended to update the Podman version to obtain the updated `runc` files. By updating Podman, the missing runc files will be installed, allowing containers to be deployed successfully.
1010

1111
Use the following command to update Podman:
1212
[source,terminal]

modules/running-quay-debug-mode.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Use the following procedure to run the {productname} Operator in debug mode.
2929

3030
.Procedure
3131

32-
. Enter the following command to edit the `QuayRegistry` CRD:
32+
. Enter the following command to edit the `QuayRegistry` custom resource definition:
3333
+
3434
[source,terminal]
3535
----

0 commit comments

Comments
 (0)