Red Hat Bugzilla – Bug 1619535
[admin] Doc link is still using upstream doc url on networkpolicy page
Last modified: 2018-10-11 03:25:43 EDT
Description of problem: Create a networkPolicy, check the detail page. Link of "Network Policies Documentation." need update. Version-Release number of selected component (if applicable): registry.reg-aws.openshift.com:443/openshift3/ose-console v3.11 8b58053eb16b Kubernetes v1.11.0+d4cacc0 OpenShift Container Platform How reproducible: Always Steps to Reproduce: 1. Go to Network Policies page and create by default template. 2. On the detail page, check the doc link of "Network Policies Documentation." Actual results: Link is https://kubernetes.io/docs/concepts/services-networking/network-policies/ Expected results: Link should be from doc of OCP. Additional info:
Not really sure if we swap the link for your docs, since the upstream docs are describing directly NetworkPolicy resource. In our docs there is either: https://docs.openshift.com/container-platform/3.10/admin_guide/managing_networking.html or more accurate: https://docs.openshift.com/container-platform/3.10/admin_guide/managing_networking.html#admin-guide-networking-networkpolicy but both of them contain lots of other info as well. Do we want point all our console docs link exclusively to OCP docs?
It's probably better to link to the OpenShift doc, although we might want the Kubernetes doc if running on upstream Kubernetes. We don't have a lot of doc links in admin console, so we haven't yet developed a good pattern here. I feel like the bigger problem specifically for network policy is that we show the resource in the top-level nav without knowing whether ovs-networkpolicy is enabled. It would be nice to hide or show it based on the enabled SDN plugin for the cluster.
Fixing PR: https://github.com/openshift/console/pull/435
Agree with "It would be nice to hide or show it based on the enabled SDN plugin for the cluster.". Could you help to file a Jira ticket if really implement it so that QE can add a test case for it? Thanks.
I don't think we have a way to know if the network policy plugin is enabled :(
Hasn't been merged into v3.11.0-0.20.0, will test on newer version.
Fixed merged in registry.dev.redhat.io/openshift3/ose-console v3.11.0 20856b6879509 283MB Now "Network Policies Documentation." points to https://docs.openshift.com/container-platform/3.11/admin_guide/managing_networking.html#admin-guide-networking-networkpolicy
Since the problem described in this bug report should be resolved in a recent advisory, it has been closed with a resolution of ERRATA. For information on the advisory, and where to find the updated files, follow the link below. If the solution does not work for you, open a new bug report. https://access.redhat.com/errata/RHBA-2018:2652