Skip to content

Commit f451ef9

Browse files
docs: fix broken kubernetes links (#8531)
* docs: fix broken kubernetes links Refs: #8530 * docs: adjust href link texts for persistent volume and service account files as deployment file * docs: fix grammar issues and highlight links for visibility Co-authored-by: Kevin Martens <[email protected]> --------- Co-authored-by: Kevin Martens <[email protected]>
1 parent 1232f2d commit f451ef9

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

content/doc/book/installing/_kubernetes.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ We choose to use the `/data` directory. This directory will contain our Jenkins
4343

4444
*We will create a volume which is called jenkins-pv:*
4545

46-
. Paste the content from link:https://raw.githubusercontent.com/jenkins-infra/jenkins.io/master/content/doc/tutorials/kubernetes/installing-jenkins-on-kubernetes/jenkins-01-volume.yaml[https://raw.githubusercontent.com/installing-jenkins-on-kubernetes/jenkins-01-volume.yaml] into a YAML formatted file called `jenkins-01-volume.yaml`.
46+
. Paste the content from the link:https://raw.githubusercontent.com/jenkins-infra/jenkins.io/master/content/doc/tutorials/kubernetes/installing-jenkins-on-kubernetes/jenkins-01-volume.yaml[persistent volume file] into a YAML formatted file called `jenkins-01-volume.yaml`.
4747
. Run the following command to apply the spec:
4848
+
4949
[source,bash]
@@ -96,7 +96,7 @@ A RoleBinding may reference any Role in the same namespace.
9696
Alternatively, a RoleBinding can reference a ClusterRole and bind that ClusterRole to the namespace of the RoleBinding.
9797
To bind a ClusterRole to all the namespaces in our cluster, we use a ClusterRoleBinding.
9898

99-
. Paste the content from link:https://raw.githubusercontent.com/jenkins-infra/jenkins.io/master/content/doc/tutorials/kubernetes/installing-jenkins-on-kubernetes/jenkins-02-sa.yaml[https://raw.githubusercontent.com/installing-jenkins-on-kubernetes/jenkins-02-sa.yaml] into a YAML formatted file called
99+
. Paste the content from the link:https://raw.githubusercontent.com/jenkins-infra/jenkins.io/master/content/doc/tutorials/kubernetes/installing-jenkins-on-kubernetes/jenkins-02-sa.yaml[service account file] into a YAML formatted file called
100100
`jenkins-02-sa.yaml`.
101101
+
102102
. Run the following command to apply the spec:
@@ -282,9 +282,9 @@ The YAML files are easily tracked, edited, and can be reused indefinitely.
282282

283283
=== Create Jenkins deployment file
284284

285-
Copy the contents link:https://raw.githubusercontent.com/jenkins-infra/jenkins.io/master/content/doc/tutorials/kubernetes/installing-jenkins-on-kubernetes/jenkinsHelm-03-deployment.yaml[here] into your preferred text editor and create a jenkinsHelm-03-deployment.yaml file in the “jenkins” namespace we created in this link:/doc/book/installing/kubernetes/#create-a-namespace[section] above.
285+
Copy the contents from link:https://raw.githubusercontent.com/jenkins-infra/jenkins.io/master/content/doc/tutorials/kubernetes/installing-jenkins-on-kubernetes/jenkins-03-deployment.yaml[this file] into your preferred text editor and create a jenkins-03-deployment.yaml file in the “jenkins” namespace we created in the link:/doc/book/installing/kubernetes/#create-a-namespace[above section].
286286

287-
* This link:https://raw.githubusercontent.com/jenkins-infra/jenkins.io/master/content/doc/tutorials/kubernetes/installing-jenkins-on-kubernetes/jenkinsHelm-03-deployment.yaml[deployment file] is defining a Deployment as indicated by the `kind` field.
287+
* This link:https://raw.githubusercontent.com/jenkins-infra/jenkins.io/master/content/doc/tutorials/kubernetes/installing-jenkins-on-kubernetes/jenkins-03-deployment.yaml[deployment file] is defining a Deployment as indicated by the `kind` field.
288288
* The Deployment specifies a single replica. This ensures one and only one instance
289289
will be maintained by the Replication Controller in the event of failure.
290290
* The container image name is `jenkins` and version is a floating tag `lts-jdk21`
@@ -310,7 +310,7 @@ To create the deployment execute:
310310

311311
[source,bash]
312312
----
313-
kubectl create -f jenkinsHelm-03-deployment.yaml -n jenkins
313+
kubectl create -f jenkins-03-deployment.yaml -n jenkins
314314
----
315315

316316
The command also instructs the system to install Jenkins within the jenkins namespace.
@@ -334,9 +334,9 @@ It allows us to maintain a persistent connection to the pod regardless of the ch
334334
With a local deployment, this means creating a NodePort service type.
335335
A NodePort service type exposes a service on a port on each node in the cluster.
336336
The service is accessed through the Node IP address and the service nodePort.
337-
A simple service is defined link:https://raw.githubusercontent.com/jenkins-infra/jenkins.io/master/content/doc/tutorials/kubernetes/installing-jenkins-on-kubernetes/jenkinsHelm-04-service.yaml[here]:
337+
A simple service is defined link:https://raw.githubusercontent.com/jenkins-infra/jenkins.io/master/content/doc/tutorials/kubernetes/installing-jenkins-on-kubernetes/jenkins-04-service.yaml[in this file]:
338338

339-
* This link:https://raw.githubusercontent.com/jenkins-infra/jenkins.io/master/content/doc/tutorials/kubernetes/installing-jenkins-on-kubernetes/jenkinsHelm-04-service.yaml[service file] is defining a Service as
339+
* This link:https://raw.githubusercontent.com/jenkins-infra/jenkins.io/master/content/doc/tutorials/kubernetes/installing-jenkins-on-kubernetes/jenkins-04-service.yaml[service file] is defining a Service as
340340
indicated by the `kind` field.
341341
* The Service is of type NodePort. Other options are ClusterIP (only accessible within the cluster) and LoadBalancer (IP address assigned by a cloud provider e.g. AWS Elastic IP).
342342
* The list of ports specified within the spec is a list of ports exposed by this service.
@@ -348,7 +348,7 @@ To create the service execute:
348348

349349
[source,bash]
350350
----
351-
kubectl create -f jenkinsHelm-04-service.yaml -n jenkins
351+
kubectl create -f jenkins-04-service.yaml -n jenkins
352352
----
353353

354354
To validate that creating the service was successful you can run:

0 commit comments

Comments
 (0)