Skip to content

Commit e5af409

Browse files
jab-rhjab-rh
authored
Merge pull request #58067 from ShaunaDiaz/OCPBUGS10029
OCPBUGS10029: correct cluster access modules MicroShift
2 parents 11326a5 + 2327499 commit e5af409

8 files changed

+75
-78
lines changed

‎microshift_install/microshift-embed-in-rpm-ostree.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ include::modules/microshift-provisioning-ostree.adoc[leveloffset=+1]
4040
4141
include::modules/microshift-accessing.adoc[leveloffset=+1]
4242
include::modules/microshift-accessing-cluster-locally.adoc[leveloffset=+2]
43-
include::modules/microshift-accessing-cluster-remotely-admin.adoc[leveloffset=+2]
44-
include::modules/microshift-accessing-cluster-remotely-non-admin.adoc[leveloffset=+2]
43+
include::modules/microshift-accessing-cluster-open-firewall.adoc[leveloffset=+2]
44+
include::modules/microshift-accessing-cluster-remotely.adoc[leveloffset=+2]
4545

4646
//note: System requirements for installing MicroShift xref works on Netlify and local previews

‎microshift_install/microshift-install-rpm.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ include::modules/microshift-accessing.adoc[leveloffset=+1]
4040
* xref:../microshift_cli_ref/microshift-oc-cli-install.adoc#microshift-oc-cli-install[Installing the OpenShift CLI tool].
4141
4242
include::modules/microshift-accessing-cluster-locally.adoc[leveloffset=+2]
43-
include::modules/microshift-accessing-cluster-remotely-admin.adoc[leveloffset=+2]
44-
include::modules/microshift-accessing-cluster-remotely-non-admin.adoc[leveloffset=+2]
43+
include::modules/microshift-accessing-cluster-open-firewall.adoc[leveloffset=+2]
44+
include::modules/microshift-accessing-cluster-remotely.adoc[leveloffset=+2]
4545

4646
//note: additional resources are deliberately set without ID and context so that they trail modules; these are not intended to appear as assembly-level additional resources

‎modules/microshift-accessing-cluster-locally.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
// Module included in the following assemblies:
22
//
3-
// microshift/microshift-install-rpm.adoc
3+
// microshift/microshift_install/microshift-install-rpm.adoc
4+
// microshift/microshift_install/microshift-embed-in-rpm-ostree.adoc
45

56
:_content-type: PROCEDURE
67
[id="accessing-microshift-cluster-locally_{context}"]
78
= Accessing the {product-title} cluster locally
89

9-
Use the following procedure to access the {product-title} cluster locally.
10+
Use the following procedure to access the {product-title} cluster locally by using a `kubeconfig` file.
1011

1112
.Prerequisites
1213

@@ -21,14 +22,14 @@ Use the following procedure to access the {product-title} cluster locally.
2122
$ mkdir -p ~/.kube/
2223
----
2324

24-
. Copy the generated `kubeconfig` file to the `~/.kube/` folder by running the following command:
25+
. Copy the generated local access `kubeconfig` file to the `~/.kube/` directory by running the following command:
2526
+
2627
[source,terminal]
2728
----
2829
$ sudo cat /var/lib/microshift/resources/kubeadmin/kubeconfig > ~/.kube/config
2930
----
3031

31-
. Update the permissions on your `~/.kube/config` file by running the following command:
32+
. Update the permissions on your `~/.kube/config` file by running the following command:
3233
+
3334
[source,terminal]
3435
----

‎modules/microshift-accessing-cluster-remotely-admin.adoc renamed to ‎modules/microshift-accessing-cluster-open-firewall.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
// Module included in the following assemblies:
22
//
3-
// microshift/microshift-install-rpm.adoc
3+
// microshift/microshift_install/microshift-install-rpm.adoc
4+
// microshift/microshift_install/microshift-embed-in-rpm-ostree.adoc
45

56
:_content-type: PROCEDURE
6-
[id="accessing-microshift-cluster-remotely-as-admin_{context}"]
7-
= Accessing the {product-title} cluster remotely as admin
7+
[id="microshift-accessing-cluster-open-firewall_{context}"]
8+
= Opening the firewall for remote access to the {product-title} cluster
89

9-
Use the following procedure to access the {product-title} cluster as an admin. Your account must have cluster admin privileges. This procedure must be completed before a workstation user can access the cluster remotely.
10+
Use the following procedure to open the firewall so that a remote user can access the {product-title} cluster. Your account must have cluster admin privileges. This procedure must be completed before a workstation user can access the cluster remotely.
1011

1112
* `user@microshift`, is the user on the {product-title} host machine and is responsible for setting up that machine so that it can be accessed by a remote user on a separate workstation.
1213

‎modules/microshift-accessing-cluster-remotely-non-admin.adoc

Lines changed: 0 additions & 63 deletions
This file was deleted.

‎modules/microshift-accessing-cluster-remotely.adoc

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
// Module included in the following assemblies:
2+
//
3+
// microshift/microshift_install/microshift-install-rpm.adoc
4+
// microshift/microshift_install/microshift-embed-in-rpm-ostree.adoc
5+
6+
:_content-type: PROCEDURE
7+
[id="accessing-microshift-cluster-remotely_{context}"]
8+
= Accessing the {product-title} cluster remotely
9+
10+
Use the following procedure to access the {product-title} cluster from a remote workstation by using a `kubeconfig` file.
11+
12+
* The `user@workstation` login is used to access the host machine remotely. The `<user>` value in the procedure is the name of the user that `user@workstation` logs in with to the {product-title} host.
13+
14+
.Prerequisites
15+
16+
* You have installed the the `oc` binary.
17+
18+
* The `@user@microshift` has opened the firewall from the local host.
19+
20+
.Procedure
21+
22+
. As `user@workstation`, create a `~/.kube/` folder if your {op-system} machine does not have one by running the following command:
23+
+
24+
[source,terminal,subs="attributes+"]
25+
----
26+
[user@workstation]$ mkdir -p ~/.kube/
27+
----
28+
29+
. As `user@workstation`, set a variable for the hostname of your {product-title} host by running the following command:
30+
+
31+
[source,terminal,subs="attributes+"]
32+
----
33+
[user@workstation]$ MICROSHIFT_MACHINE=<name or IP address of {product-title} machine>
34+
----
35+
36+
. As `user@workstation`, copy the generated `kubeconfig` file that contains the host name or IP address you want to connect with from the {op-system} machine running {product-title} to your local machine by running the following command:
37+
+
38+
[source,terminal]
39+
----
40+
[user@workstation]$ ssh <user>@$MICROSHIFT_MACHINE "sudo cat /var/lib/microshift/resources/kubeadmin/$MICROSHIFT_MACHINE/kubeconfig" > ~/.kube/config
41+
----
42+
43+
. As `user@workstation`, update the permissions on your `~/.kube/config` file by running the following command:
44+
+
45+
[source,terminal]
46+
----
47+
$ chmod go-r ~/.kube/config
48+
----
49+
50+
.Verify {product-title} is running
51+
52+
. As `user@workstation`, verify that {product-title} is running by running the following command:
53+
+
54+
[source,terminal]
55+
----
56+
[user@workstation]$ oc get all -A
57+
----

‎modules/microshift-accessing.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
// Module included in the following assemblies:
22
//
3-
// microshift/microshift-install-rpm.adoc
3+
// microshift/microshift_install/microshift-install-rpm.adoc
4+
// microshift/microshift_install/microshift-embed-in-rpm-ostree.adoc
45

56
:_content-type: CONCEPT
67
[id="accessing-microshift-cluster_{context}"]
78
= How to access the {product-title} cluster
89

9-
Use the procedures in this section to access the {product-title} cluster locally, either from the same machine running the {product-title} service or remotely from a workstation. You can use this access to observe and administrate workloads. The {OCP} CLI tool (`oc`) is employed for cluster access.
10+
Use the procedures in this section to access the {product-title} cluster, either from the same machine running the {product-title} service or remotely from a workstation. You can use this access to observe and administrate workloads. When using these steps, choose the `kubeconfig` file that contains the host name or IP address you want to connect with and place it in the relevant directory. The {OCP} CLI tool (`oc`) is employed for cluster activities.

‎modules/microshift-install-rpm-preparing.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ To configure a volume group (VG) that allows LVMS to create the LVs for your wor
2121

2222
. In the graphical installer under *Storage Configuration*, select *Custom* -> *Done* to open the dialog for configuring partitions and volumes.
2323

24-
. Under *New Red Hat Enterprise Linux 8.x Installation*, select *Click here to create them automatically*.
24+
. Under *New Red Hat Enterprise Linux 9.x Installation*, select *Click here to create them automatically*.
2525

2626
. Select the root partition, */*, reduce *Desired Capacity* so that the VG has sufficient capacity for your PVs, and then click *Update Settings*.
2727

0 commit comments

Comments
 (0)