Skip to content

Commit

Permalink
fix: added docs about Lens
Browse files Browse the repository at this point in the history
  • Loading branch information
jstrachan committed Aug 10, 2021
1 parent 6d06110 commit 0905dc2
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 2 deletions.
3 changes: 3 additions & 0 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,9 @@ disableKinds = ["taxonomy", "taxonomyTerm"]
## Used for views in rendered HTML (i.e., rather than using the .Hugo variable)
release = "3.2.182"

## the jx-lens version
jx_lens_version = "1.0.5"

copyright = "The Jenkins X Authors."
privacy_policy = "https://policies.google.com/privacy"

Expand Down
36 changes: 36 additions & 0 deletions content/en/v3/develop/ui/lens.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Lens
linktitle: Lens
type: docs
description: desktop Jenkins X Console based on Lens
weight: 50
---

[Lens](https://k8slens.dev/) is a desktop console for Kubernetes which runs locally on your laptop as a desktop application.



## Install Lens

[Download the Lens distribution](https://k8slens.dev/#download) for your computer then run it or follow the [getting started guide](https://docs.k8slens.dev/main/getting-started/)

You can check out the [catalog documentation](https://docs.k8slens.dev/main/catalog/) for how to connect to a kubernetes cluster.

## Install the Jenkins X extension

[Lens](https://k8slens.dev/) supports [extensions](https://k8slens.dev/#extensions) to support custom UIs for different extensions to Kubernetes such as Jenkins X.

Follow the Lens documentation on [installing an extension](https://docs.k8slens.dev/main/extensions/usage/#installing-an-extension) using the following URL for the [Jenkins X Lens extension](https://github.com/jenkins-x-plugins/jx-lens)


* go to the **File** (or **Lens** on macOS) > **Extensions** in the application menu
* enter the following URL into the **Install Extension** input field
* https://registry.npmjs.org/@jenkins-x-plugins/jx-lens/-/jx-lens-{{< jx-lens-version >}}.tgz
* make sure the extension is **Enabled**


## Using the Jenkins X extension

Once you have used the usual Lens way to connect to your cluster you can browse the usual Kubernetes resources like `Nodes`, `Workloads` and `Configuration`.

You should see the `Jenkins X` tab below the `Custom Resources` section. If you expand that you can then navigate to your `Pipelines` and `Preview` environments as well.
4 changes: 2 additions & 2 deletions content/en/v3/develop/ui/octant.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
title: Console
linktitle: Console
type: docs
description: Jenkins X Console based on Octant
description: desktop Jenkins X Console based on Octant
weight: 50
aliases:
- /v3/develop/ui/octant
---

As a general purpose console for working with Kubernetes, Jenkins X, Tekton and more resources we highly recommend [Octant](https://octant.dev/)
As a general purpose console for working with Kubernetes, Jenkins X, Tekton and more resources we highly recommend either [Octant](https://octant.dev/) or [Lens](/v3/develop/ui/lens/)

To run the [Octant](https://octant.dev/) UI please make sure you are in a local terminal (not inside a VM) as it will run a local process and open a web browser to access a local port.

Expand Down
1 change: 1 addition & 0 deletions layouts/shortcodes/jx-lens-version.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{ .Site.Params.jx_lens_version }}

0 comments on commit 0905dc2

Please sign in to comment.