Skip to content

Commit 532f8e2

Browse files
authored
fixed documentation (#168)
Signed-off-by: Luca Stocchi <[email protected]>
1 parent 2b0bf61 commit 532f8e2

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

docs/getting-started.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,16 @@ The following paragraphs guide you through the process of using this extension.
55

66
<!-- MarkdownTOC autolink="true" autoanchor="true" -->
77

8-
- [Configuring the OpenShift service connection](#configuring-the-openshift-service-connection)
9-
- [Basic Authentication](#basic-authentication)
10-
- [Token Authentication](#token-authentication)
11-
- [Kubeconfig](#kubeconfig)
8+
- [Connect to your OpenShift cluster](connect-to-your-openshift-cluster)
9+
- [Configuring the OpenShift service connection](#configuring-the-openshift-service-connection)
10+
- [Basic Authentication](#basic-authentication)
11+
- [Token Authentication](#token-authentication)
12+
- [Kubeconfig](#kubeconfig)
13+
- [Set up OpenShift connection runtime](#setup-the-openshift-connection-runtime)
1214
- [Pipeline Tasks](#pipeline-tasks)
1315
- [Install and setup oc](#install-and-setup-oc)
1416
- [Executing single oc commands](#executing-single-oc-commands)
17+
- [Executing single conditional oc commands](#executing-single-conditional-oc-commands)
1518
- [Updating a ConfigMap](#updating-a-configmap)
1619
- [YAML configuration](#yaml-configuration)
1720

@@ -22,6 +25,7 @@ The following paragraphs guide you through the process of using this extension.
2225

2326
To use any of the pipeline tasks, you first need a way to connect to your cluster.
2427
In Azure DevOps, access to external and remote services is configured in [service connections](https://docs.microsoft.com/en-us/azure/devops/pipelines/library/service-endpoints?view=vsts).
28+
2529
The OpenShift extension for Azure DevOps provides two ways to set up a connection: <a href="#configuring-the-openshift-service-connection">create a custom OpenShift service connection type <a> which allows you to connect to your cluster using various authentication forms or <a href="#setup-the-openshift-connection-runtime">by defining it at Task level</a> when creating your pipeline.
2630

2731
![Service Connection Types](../images/service-connection-types.png)
@@ -106,9 +110,11 @@ To set up an OpenShift connection at runtime, select the _Set Up Configuration o
106110
You should be displayed with two options: File Path and Inline Configuration.
107111

108112
- File Path allows you to add a path where the agent will find the config file to use during the execution
113+
109114
![file path connection type](../images/file-path-connection-type.png)
110115

111116
- Inline Configuration expects you to copy the content of your config. The extension will create a new config file with the content inserted
117+
112118
![inline configuration connection type](../images/inline-config-connection-type.png)
113119

114120
<a id="pipeline-tasks"></a>
@@ -139,9 +145,9 @@ The _Install oc_ has three configuration options.
139145

140146
<dl>
141147
<dt>Service Connection Type</dt>
142-
<dd>Required. Allows to set up a connection at runtime or by choosing an existing service connection. See <a href="#connect-to-your-openshift-cluster">_Connect to your OpenShift cluster_</a>.</dd>
148+
<dd>Required. Allows to set up a connection at runtime or by choosing an existing service connection. See <a href="#connect-to-your-openshift-cluster">Connect to your OpenShift cluster</a>.</dd>
143149
<dt>Version of oc to use</dt>
144-
<dd>Allows to specify the version of oc to use for command execution, eg v3.10.0. If left blank the latest stable version is used. You can also specify a direct URL to the oc release bundle. See <a href="#how-the-cache-works">_How the cache works_</a></dd>
150+
<dd>Allows to specify the version of oc to use for command execution, eg v3.10.0. If left blank the latest stable version is used. You can also specify a direct URL to the oc release bundle. See <a href="#how-the-cache-works">How the cache works</a></dd>
145151
<dt>Proxy</dt>
146152
<dd>Allows to specify a proxy (host:port) to use to download oc cli</dd>
147153
</dl>
@@ -160,9 +166,9 @@ The _Execute oc command_ has six configuration options.
160166

161167
<dl>
162168
<dt>Service Connection Type</dt>
163-
<dd>Required. Allows to set up a connection at runtime or by choosing an existing service connection. See <a href="#connect-to-your-openshift-cluster">_Connect to your OpenShift cluster_</a>.</dd>
169+
<dd>Required. Allows to set up a connection at runtime or by choosing an existing service connection. See <a href="#connect-to-your-openshift-cluster">Connect to your OpenShift cluster</a>.</dd>
164170
<dt>Version of oc to use</dt>
165-
<dd>Allows to specify the version of oc to use for command execution, eg v3.10.0. If left blank the latest stable version is used. You can also specify a direct URL to the oc release bundle. See <a href="#how-the-cache-works">_How the cache works_</a></dd>
171+
<dd>Allows to specify the version of oc to use for command execution, eg v3.10.0. If left blank the latest stable version is used. You can also specify a direct URL to the oc release bundle. See <a href="#how-the-cache-works">How the cache works</a></dd>
166172
<dt>Command to run</dt>
167173
<dd>The actual oc command to run starting with the oc sub-command, eg "rollout latest dc/my-app -n production". <a href="#command-features">Check the notes below</a> to find out more features supported by the extension.</dd>
168174
<dt>Ignore on success return value</dt>
@@ -224,7 +230,7 @@ oc describe pod/nodejs-ex | grep kubernetes > /path/log.txt
224230

225231
---
226232

227-
<a id="executing-single-oc-commands"></a>
233+
<a id="executing-single-conditional-oc-commands"></a>
228234
### Executing conditional oc commands
229235

230236
In case you want to execute a single conditional `oc` command you can use the _Execute conditional oc command_ task.
@@ -236,9 +242,9 @@ The _Execute conditional oc command_ has ten configuration options.
236242

237243
<dl>
238244
<dt>Service Connection Type</dt>
239-
<dd>Required. Allows to set up a connection at runtime or by choosing an existing service connection. See <a href="#connect-to-your-openshift-cluster">_Connect to your OpenShift cluster_</a>.</dd>
245+
<dd>Required. Allows to set up a connection at runtime or by choosing an existing service connection. See <a href="#connect-to-your-openshift-cluster">Connect to your OpenShift cluster</a>.</dd>
240246
<dt>Version of oc to use</dt>
241-
<dd>Allows to specify the version of oc to use for command execution, eg v3.10.0. If left blank the latest stable version is used. You can also specify a direct URL to the oc release bundle. See <a href="#how-the-cache-works">_How the cache works_</a></dd>
247+
<dd>Allows to specify the version of oc to use for command execution, eg v3.10.0. If left blank the latest stable version is used. You can also specify a direct URL to the oc release bundle. See <a href="#how-the-cache-works">How the cache works</a></dd>
242248
<dt>Command to run</dt>
243249
<dd>The oc command to run whenever the condition is met, eg "rollout latest dc/my-app -n production". <a href="#command-features">Check the additional features</a> supported by the extension.</dd>
244250
<dt>Ignore on success return value</dt>
@@ -283,9 +289,9 @@ The _Update ConfigMap_ task has six configuration options.
283289

284290
<dl>
285291
<dt>Service Connection Type</dt>
286-
<dd>Required. Allows to set up a connection at runtime or by choosing an existing service connection. See <a href="#connect-to-your-openshift-cluster">_Connect to your OpenShift cluster_</a>.</dd>
292+
<dd>Required. Allows to set up a connection at runtime or by choosing an existing service connection. See <a href="#connect-to-your-openshift-cluster">Connect to your OpenShift cluster</a>.</dd>
287293
<dt>Version of oc to use</dt>
288-
<dd>Allows to specify the version of oc to use for command execution, eg v3.10.0. If left blank the latest stable version is used. You can also specify a direct URL to the oc release bundle. See <a href="#how-the-cache-works">_How the cache works_</a></dd>
294+
<dd>Allows to specify the version of oc to use for command execution, eg v3.10.0. If left blank the latest stable version is used. You can also specify a direct URL to the oc release bundle. See <a href="#how-the-cache-works">How the cache works</a></dd>
289295
<dt>Name of ConfigMap</dt>
290296
<dd>Required.The name of the ConfigMap to update.</dd>
291297
<dt>Namespace of ConfigMap</dt>

0 commit comments

Comments
 (0)