Bug 1859021 - update links, version number, and screenshots
Summary: update links, version number, and screenshots
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat OpenShift Container Storage
Classification: Red Hat Storage
Component: documentation
Version: 4.5
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: ---
: OCS 4.5.0
Assignee: Olive Lakra
QA Contact: Elena Bondarenko
URL:
Whiteboard:
Depends On:
Blocks: 1826397
TreeView+ depends on / blocked
 
Reported: 2020-07-21 06:11 UTC by Anjana Suparna Sriram
Modified: 2020-09-16 07:43 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-09-16 07:42:32 UTC
Embargoed:


Attachments (Terms of Use)

Comment 3 Neha Berry 2020-08-25 18:51:55 UTC
One link to check if it works in Managing guide [1]

Link :  You must have installed local storage operator. For information, see *Installing Local Storage Operator* . -> It needs to take to a Dpeloyment guide (be it BM, Vmware LSO )

[1] - https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/managing_openshift_container_storage/index?lb_target=preview#scaling-up-storage-by-adding-capacity-to-your-openshift-container-storage-nodes-using-local-storage-devices_rhocs

Comment 8 Elena Bondarenko 2020-08-28 09:09:01 UTC
In Managin guide there are a few links to the deployment guide that are not working:

2.3.2. Configuring cluster logging to use OpenShift Container Storage in the last note "To uninstall cluster logging backed by Persistent Volume Claim, use the steps in Removing the cluster logging operator from OpenShift Container Storage". - broken link https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/deploying_openshift_container_storage/index#removing-cluster-logging-operator-from-openshift-container-storage_aws-vmware 

4.1. Requirements for scaling storage nodes
Before you proceed to scale the storage nodes, refer to the following sections to understand the node requirements for your specific Red Hat OpenShift Container Storage instance:

Platform requirements - broken link https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/planning_your_deployment/index#platform-requirements_rhocs
Storage device requirements

Dynamic storage devices - broken link https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/planning_your_deployment/index#dynamic_storage_devices
Local storage devices - broken link hhttps://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/planning_your_deployment/index#local_storage_devices
Capacity planning - broken link https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/planning_your_deployment/index#capacity_planning


4.2.2. Scaling up storage by adding capacity to your OpenShift Container Storage nodes using local storage devices
Prerequisites

Installing Local Storage Operator on bare metal - broken link https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/deploying_openshift_container_storage_using_bare_metal_infrastructure/index#installing-local-storage-operator_rhocs
Installing Local Storage Operator on vSphere cluster https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/deploying_openshift_container_storage_on_vmware_vsphere/index#installing-local-storage-operator_local-storage

Procedure

Find the unique by-id identifier for available devices that you want to add, that is, a minimum of one device per worker node. Follow procedure finding available storage devices. - broken link to https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/deploying_openshift_container_storage/index#finding-available-storage-devices_aws-vmware

Comment 9 Elena Bondarenko 2020-08-28 09:24:51 UTC
In my previous comment only the first  and the last links is really broken, the rest could be opened with ?lb_target=preview added to the link.

Comment 12 Elena Bondarenko 2020-08-28 17:13:51 UTC
Another couple of issues: 

Managing guide: 

"9.3.1. Replacing failed storage devices on Amazon EC2 infrastructure
When you need to replace a storage device on an Amazon EC2 (storage-optimized I3) infrastructure, you must replace the storage node. For information about how to replace nodes, see Replacing failed storage nodes on Amazon EC2 infrastructure". - The link leads to 4.4 version instead of 4.5 (https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.4/html-single/managing_openshift_container_storage/index#replacing-failed-storage-nodes-on-amazon-ec2-infrastructure_rhocs)

"Chapter 10. Updating OpenShift Container Storage
You can update OpenShift Container Storage in:
internal mode
disconnected environment" - the link to updating in disconnected environment has a wrong anchor, #preparing_to_update_in_a_disconnected_environment_rhocs instead of #preparing_to_update_in_a_disconnected_environment, so it leads to the very beginning of the guide instead of the correct chapter 10.2.


Troubleshooting guide:

Chapter 5. Checking for Local Storage Operator deployments
"Additional Resources
Deploying OpenShift Container Storage using local storage devices" - broken link https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/deploying_openshift_container_storage/index?lb_target=preview#deploying-openshift-container-storage-using-local-storage-devices_aws-vmware


Also there's a couple of broken links in Release notes 
https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/4.5_release_notes/index?lb_target=preview#new_features
Chapter 2. New Features 
"For more information, see External mode requirements and how to create external storage cluster service" - link on "how to create external storage cluster service" https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/deploying_openshift_container_storage/index?lb_target=preview#creating-an-openshift-container-storage-cluster-service-for-external-storage_aws-vmware

Chapter 4. Technology previews
Microsoft Azure Technology Preview support
"OpenShift Container Storage can now be installed and managed on Microsoft Azure. For more information see, the Deploying and managing OpenShift Container Storage on Microsoft Azure guide". - the link is https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/deploying_and_managing_openshift_container_storage_on_microsoft_azure/index, and it should be 
https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/deploying_and_managing_openshift_container_storage_using_microsoft_azure/index

I'll finish checking all deployment guides on Monday.

Comment 14 Elena Bondarenko 2020-08-31 14:23:44 UTC
DEPLOYING AND MANAGING OPENSHIFT CONTAINER STORAGE USING GOOGLE CLOUD
1.3. Creating an OpenShift Container Storage Cluster Service in internal mode
"The OpenShift Container Storage operator must be installed from the Operator Hub. For more information, see Installing OpenShift Container Storage Operator using the Operator Hub" - link to https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/deploying_openshift_container_storage_using_google-cloud/#installing-openshift-container-storage-operator-using-the-operator-hub doesn't work, it should be deploying_and_managing_openshift_container_storage_using_google_cloud

3.2. Removing monitoring stack from OpenShift Container Storage
Procedure
3. Remove any config sections that reference the OpenShift Container Storage storage classes as shown in the following example and save it.
"Before editing" and "After editing" shouldn't have black backg round colour, as these notes are not part of the screenshot. 

Chapter 4. Configure storage for OpenShift Container Platform services
WARNING
Red Hat recommends configuring shorter curation and retention intervals for these services. See Configuring Curator and Modifying retention time for Prometheus metrics data in the OpenShift Container Platform documentation for details. - the links "Configuring Curator" and "Modifying retention time for Prometheus metrics data" lead to version 4.4

4.3. Cluster logging for OpenShift Container Storage
You can deploy cluster logging to aggregate logs for a range of OpenShift Container Platform services. For information about how to deploy cluster logging, see Deploying cluster logging - the link leads to version 4.3

Red Hat recommends configuring shorter curation and retention intervals for these services. See Configuring Curator in the OpenShift Container Platform documentation for details. - the link "Configuring Curator" leads to version 4.3

6.3.3. Scaling up storage capacity
After you add a new node to OpenShift Container Storage, you must scale up the storage capacity as described in Scaling up storage by adding capacity. - the anchor isn't working correctly, the link leads to the beginning of the document instead of the correct chapter.

10.1. Replacing operational or failed storage devices on Google Cloud installer-provisioned infrastructure
"When you need to replace a device in a dynamically created storage cluster on an Google Cloud installer-provisioned infrastructure, you must replace the storage node. For information about how to replace nodes, see:
Replacing operational nodes on Google Cloud installer-provisioned infrastructure
Replacing failed nodes on Google Cloud installer-provisioned infrastructures"
The anchors of both links (replacing operational nodes and replacing failed nodes) are not working. The anchors in chapter 9 are working, but they have _azure at the end, which doesn't look right.

Comment 15 Elena Bondarenko 2020-08-31 15:05:04 UTC
DEPLOYING AND MANAGING OPENSHIFT CONTAINER STORAGE USING MICROSOFT AZURE

Chapter 1. Deploying OpenShift Container Storage on Microsoft Azure
"1. For Red Hat Enterprise Linux based hosts, enable the container access to the underlying file system. Follow the instructions on enabling file system access for containers on Red Hat Enterprise Linux based nodes". - the link leads to AWS guide instead of the correct part of Azure guide

The rest of the problems are the same as in the guide for google cloud:

1.3. Creating an OpenShift Container Storage Cluster Service in internal mode
"The OpenShift Container Storage operator must be installed from the Operator Hub. For more information, see Installing OpenShift Container Storage Operator using the Operator Hub" - link to https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/deploying_openshift_container_storage_using_microsoft_azure/#installing-openshift-container-storage-operator-using-the-operator-hub_azure doesn't work, it should be deploying_and_managing_openshift_container_storage_using_microsoft_azure

3.2. Removing monitoring stack from OpenShift Container Storage
Procedure
3. Remove any config sections that reference the OpenShift Container Storage storage classes as shown in the following example and save it.
"Before editing" and "After editing" shouldn't have black backg round colour, as these notes are not part of the screenshot. 

Chapter 4. Configure storage for OpenShift Container Platform services
WARNING
Red Hat recommends configuring shorter curation and retention intervals for these services. See Configuring Curator and Modifying retention time for Prometheus metrics data in the OpenShift Container Platform documentation for details. - the links "Configuring Curator" and "Modifying retention time for Prometheus metrics data" lead to version 4.4

4.3. Cluster logging for OpenShift Container Storage
You can deploy cluster logging to aggregate logs for a range of OpenShift Container Platform services. For information about how to deploy cluster logging, see Deploying cluster logging - the link leads to version 4.3

Red Hat recommends configuring shorter curation and retention intervals for these services. See Configuring Curator in the OpenShift Container Platform documentation for details. - the link "Configuring Curator" leads to version 4.3

Comment 16 Elena Bondarenko 2020-08-31 17:26:51 UTC
DEPLOYING AND MANAGING OPENSHIFT CONTAINER STORAGE USING MICROSOFT AZURE

6.3.3. Scaling up storage capacity
After you add a new node to OpenShift Container Storage, you must scale up the storage capacity as described in Scaling up storage by adding capacity.
The link leads to Google cloud guide instead of azure

Comment 19 Elena Bondarenko 2020-09-04 13:23:09 UTC
Managing Guide 
4.1. Requirements for scaling storage nodes
"Local storage devices" - the link has hhttps instead of https, so it doesn't work. 

I've re-checked all the documents, all the other links are working correctly.

Comment 21 Elena Bondarenko 2020-09-07 06:44:52 UTC
All links are working correctly, all screenshots are of version 4.5


Note You need to log in before you can comment on or make changes to this bug.