Skip to content

Commit

Permalink
fix: add FAQ entry
Browse files Browse the repository at this point in the history
also use nicer names for the main sections
  • Loading branch information
jstrachan committed Dec 2, 2020
1 parent 77d9b26 commit 8efa40b
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 5 deletions.
4 changes: 2 additions & 2 deletions content/en/v3/admin/_index.md
@@ -1,6 +1,6 @@
---
title: Administration
linktitle: Administration
title: Admin Guide
linktitle: Admin Guide
type: docs
description: Installing, configuring and upgrading your Jenkins X installation
date: 2017-02-01
Expand Down
6 changes: 3 additions & 3 deletions content/en/v3/develop/_index.md
@@ -1,8 +1,8 @@
---
title: Developing
linktitle: Developing
title: User Guide
linktitle: User Guide
type: docs
description: Guides on developing software with Jenkins X
description: Guides on using Jenkins X to develop and deliver software continuously
weight: 100
aliases:
- /v3/develop/
Expand Down
35 changes: 35 additions & 0 deletions content/en/v3/develop/faq/_index.md
Expand Up @@ -95,7 +95,42 @@ So if you really wanted to opt out of the canonical GitOps, resource and secret
## What is the directory layout?

To understand the directory layout see [this document](https://github.com/jenkins-x/jx-gitops/blob/master/docs/git_layout.md)


## How do I diagnose a step in a pipeline?

If you are wondering what image, command, environment variables are being used in a step in the pipeline the simplest thing is to [open the octant console](/v3/develop/ui/octant/) via:

```bash
jx ui
```

Then if you navigate to the pipeline you are interested in and select the envelope icon next to a step name that will take you to the Step details page. e.g. if you click on the icon pointed to by the big red arrow:

<figure>
<img src="/images/developing/octant-step-click.png" />
<figcaption>
<h5>Click on the step icon to see details of a step which then takes you to the step details page</h5>
</figcaption>
</figure>


<figure>
<img src="/images/developing/octant-step.png" />
<figcaption>
<h5>Step details page lets you see the command, image, environment variables and volumes</h5>
</figcaption>
</figure>

If that doesn't help another option is to [edit the pipeline step](/v3/develop/pipeline-catalog/#editing-pipelines) via the `.lighthouse/jenkins-x/release.yaml` or `.lighthouse/jenkins-x/pullrequest.yaml` file to add the command: `sleep infinity` in the `script:` value before the command that is not working.

You can then `kubectl exec` into the pod at that step and look around and try running commands locally.

e.g. using the pod name from the above page and the container name you can do something like:

```bash
kubectl exec -it -c name-of-step-container name-of-pod sh
```

## Does Jenkins X support helmfile hooks?

Expand Down
Binary file added static/images/developing/octant-step-click.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/developing/octant-step.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8efa40b

Please sign in to comment.