You are viewing documentation for a release that is no longer maintainedSee documentation for the latest supported version 3 or the latest supported version 4.
4.2. Creating custom links in the web console
Prerequisites
You must have administrator privileges.
Procedure
From AdministrationCustom Resource Definitions, click on ConsoleLink.
Select Instances tab
Click Create Console Link and edit the file:
apiVersion: console.openshift.io/v1
kind: ConsoleLink
metadata:
name: example
spec:
href: 'https://www.example.com'
location: HelpMenu
text: Link 1
apiVersion: console.openshift.io/v1
kind: ConsoleLink
metadata:name: example
spec:href:'https://www.example.com'location: HelpMenu
1
text: Link 1
Copy to ClipboardCopied!Toggle word wrapToggle overflow
Valid location settings are HelpMenu, UserMenu, ApplicationMenu, and NamespaceDashboard.
To make the custom link appear in all namespaces, follow this example:
apiVersion: console.openshift.io/v1
kind: ConsoleLink
metadata:
name: namespaced-dashboard-link-for-all-namespaces
spec:
href: 'https://www.example.com'
location: NamespaceDashboard
text: This appears in all namespaces
apiVersion: console.openshift.io/v1
kind: ConsoleLink
metadata:name: namespaced-dashboard-link-for-all-namespaces
spec:href:'https://www.example.com'location: NamespaceDashboard
text: This appears in all namespaces
Copy to ClipboardCopied!Toggle word wrapToggle overflow
To make the custom link appear in only some namespaces, follow this example:
apiVersion: console.openshift.io/v1
kind: ConsoleLink
metadata:
name: namespaced-dashboard-for-some-namespaces
spec:
href: 'https://www.example.com'
location: NamespaceDashboard
# This text will appear in a box called "Launcher" under "namespace" or "project" in the web console
text: Custom Link Text
namespaceDashboard:
namespaces:
# for these specific namespaces
- my-namespace
- your-namespace
- other-namespace
apiVersion: console.openshift.io/v1
kind: ConsoleLink
metadata:name: namespaced-dashboard-for-some-namespaces
spec:href:'https://www.example.com'location: NamespaceDashboard
# This text will appear in a box called "Launcher" under "namespace" or "project" in the web consoletext: Custom Link Text
namespaceDashboard:namespaces:# for these specific namespaces- my-namespace
- your-namespace
- other-namespace
Copy to ClipboardCopied!Toggle word wrapToggle overflow
To make the custom link appear in the application menu, follow this example:
apiVersion: console.openshift.io/v1
kind: ConsoleLink
metadata:
name: application-menu-link-1
spec:
href: 'https://www.example.com'
location: ApplicationMenu
text: Link 1
applicationMenu:
section: My New Section
# image that is 24x24 in size
imageURL: https://via.placeholder.com/24
apiVersion: console.openshift.io/v1
kind: ConsoleLink
metadata:name: application-menu-link-1spec:href:'https://www.example.com'location: ApplicationMenu
text: Link 1
applicationMenu:section: My New Section
# image that is 24x24 in sizeimageURL: https://via.placeholder.com/24
Copy to ClipboardCopied!Toggle word wrapToggle overflow