Merge pull request #1 from fgiorgetti/simplified-aap-steps

fgiorgetti · web-flow · commit 9e11d5d6d453 · 2024-11-12T12:47:54.000-03:00
Addressed feedback reducing aap steps
diff --git a/documentation/modules/ROOT/assets/resources.tar.gz b/documentation/modules/ROOT/assets/resources.tar.gz
diff --git a/documentation/modules/ROOT/assets/resources/bundle-commands.sh b/documentation/modules/ROOT/assets/resources/bundle-commands.sh
@@ -0,0 +1,24 @@
+TARGET_DIR='internal/net-a'
+echo "mkdir -p ${TARGET_DIR}"
+echo
+
+for i in internal/net-a/*; do
+    filename=$(basename "${i}")
+    echo "cat << EOF > ${TARGET_DIR}/${filename}";
+    cat "${i}"
+    echo "EOF"
+    echo
+done
+
+cat << EOF
+kubectl -n net-a get accessgrant net-a-grant -o template --template '
+apiVersion: skupper.io/v2alpha1
+kind: AccessToken
+metadata:
+  name: net-a-token
+spec:
+  code: "{{ .status.code }}"
+  ca: {{ printf "%q" .status.ca }}
+  url: "{{ .status.url }}"
+' > ${TARGET_DIR}/30-accesstoken.yaml
+EOF
diff --git a/documentation/modules/ROOT/assets/resources/cloud/net-a/00-ns.yaml b/documentation/modules/ROOT/assets/resources/cloud/net-a/00-ns.yaml
@@ -0,0 +1,4 @@
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: net-a
diff --git a/documentation/modules/ROOT/assets/resources/cloud/net-a/10-site.yaml b/documentation/modules/ROOT/assets/resources/cloud/net-a/10-site.yaml
@@ -0,0 +1,7 @@
+apiVersion: skupper.io/v2alpha1
+kind: Site
+metadata:
+  name: net-a
+  namespace: net-a
+spec:
+  linkAccess: default
diff --git a/documentation/modules/ROOT/assets/resources/cloud/net-a/20-accessgrant.yaml b/documentation/modules/ROOT/assets/resources/cloud/net-a/20-accessgrant.yaml
@@ -0,0 +1,8 @@
+apiVersion: skupper.io/v2alpha1
+kind: AccessGrant
+metadata:
+  name: net-a-grant
+  namespace: net-a
+spec:
+  redemptionsAllowed: 1
+  expirationWindow: 30m
diff --git a/documentation/modules/ROOT/assets/resources/cloud/net-a/30-listeners.yaml b/documentation/modules/ROOT/assets/resources/cloud/net-a/30-listeners.yaml
@@ -0,0 +1,33 @@
+---
+apiVersion: skupper.io/v2alpha1
+kind: Listener
+metadata:
+  name: server-a1
+  namespace: net-a
+spec:
+  host: server-a1
+  port: 22
+  routingKey: server-a1
+  type: tcp
+---
+apiVersion: skupper.io/v2alpha1
+kind: Listener
+metadata:
+  name: server-a2
+  namespace: net-a
+spec:
+  host: server-a2
+  port: 22
+  routingKey: server-a2
+  type: tcp
+---
+apiVersion: skupper.io/v2alpha1
+kind: Listener
+metadata:
+  name: server-a3
+  namespace: net-a
+spec:
+  host: server-a3
+  port: 22
+  routingKey: server-a3
+  type: tcp
diff --git a/documentation/modules/ROOT/assets/resources/cloud/net-a/40-networkpolicy.yaml b/documentation/modules/ROOT/assets/resources/cloud/net-a/40-networkpolicy.yaml
@@ -0,0 +1,21 @@
+apiVersion: networking.k8s.io/v1
+kind: NetworkPolicy
+metadata:
+  name: network-policy-aap
+  namespace: net-a
+spec:
+  podSelector:
+    matchLabels:
+      app.kubernetes.io/name: skupper-router
+  policyTypes:
+  - Ingress
+  - Egress
+  ingress:
+  - from:
+    - namespaceSelector:
+        matchExpressions:
+        - key: 'kubernetes.io/metadata.name'
+          operator: In
+          values: ["aap", "net-a"]
+  egress:
+  - {}
diff --git a/documentation/modules/ROOT/assets/resources/cloud/net-b/00-ns.yaml b/documentation/modules/ROOT/assets/resources/cloud/net-b/00-ns.yaml
@@ -0,0 +1,4 @@
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: net-b
diff --git a/documentation/modules/ROOT/assets/resources/cloud/net-b/10-site.yaml b/documentation/modules/ROOT/assets/resources/cloud/net-b/10-site.yaml
@@ -0,0 +1,7 @@
+apiVersion: skupper.io/v2alpha1
+kind: Site
+metadata:
+  name: net-b
+  namespace: net-b
+spec:
+  linkAccess: default
diff --git a/documentation/modules/ROOT/assets/resources/cloud/net-b/20-accessgrant.yaml b/documentation/modules/ROOT/assets/resources/cloud/net-b/20-accessgrant.yaml
@@ -0,0 +1,8 @@
+apiVersion: skupper.io/v2alpha1
+kind: AccessGrant
+metadata:
+  name: net-b-grant
+  namespace: net-b
+spec:
+  redemptionsAllowed: 1
+  expirationWindow: 30m
diff --git a/documentation/modules/ROOT/assets/resources/cloud/net-b/30-listeners.yaml b/documentation/modules/ROOT/assets/resources/cloud/net-b/30-listeners.yaml
@@ -0,0 +1,33 @@
+---
+apiVersion: skupper.io/v2alpha1
+kind: Listener
+metadata:
+  name: server-b1
+  namespace: net-b
+spec:
+  host: server-b1
+  port: 22
+  routingKey: server-b1
+  type: tcp
+---
+apiVersion: skupper.io/v2alpha1
+kind: Listener
+metadata:
+  name: server-b2
+  namespace: net-b
+spec:
+  host: server-b2
+  port: 22
+  routingKey: server-b2
+  type: tcp
+---
+apiVersion: skupper.io/v2alpha1
+kind: Listener
+metadata:
+  name: server-b3
+  namespace: net-b
+spec:
+  host: server-b3
+  port: 22
+  routingKey: server-b3
+  type: tcp
diff --git a/documentation/modules/ROOT/assets/resources/cloud/net-b/40-networkpolicy.yaml b/documentation/modules/ROOT/assets/resources/cloud/net-b/40-networkpolicy.yaml
@@ -0,0 +1,21 @@
+apiVersion: networking.k8s.io/v1
+kind: NetworkPolicy
+metadata:
+  name: network-policy-aap
+  namespace: net-b
+spec:
+  podSelector:
+    matchLabels:
+      app.kubernetes.io/name: skupper-router
+  policyTypes:
+  - Ingress
+  - Egress
+  ingress:
+  - from:
+    - namespaceSelector:
+        matchExpressions:
+        - key: 'kubernetes.io/metadata.name'
+          operator: In
+          values: ["aap", "net-b"]
+  egress:
+  - {}
diff --git a/documentation/modules/ROOT/assets/resources/internal/net-a/10-site.yaml b/documentation/modules/ROOT/assets/resources/internal/net-a/10-site.yaml
@@ -0,0 +1,4 @@
+apiVersion: skupper.io/v2alpha1
+kind: Site
+metadata:
+  name: net-a
diff --git a/documentation/modules/ROOT/assets/resources/internal/net-a/20-connectors.yaml b/documentation/modules/ROOT/assets/resources/internal/net-a/20-connectors.yaml
@@ -0,0 +1,27 @@
+---
+apiVersion: skupper.io/v2alpha1
+kind: Connector
+metadata:
+  name: server-a1
+spec:
+  host: 192.168.8.101
+  port: 22
+  routingKey: server-a1
+---
+apiVersion: skupper.io/v2alpha1
+kind: Connector
+metadata:
+  name: server-a2
+spec:
+  host: 192.168.8.102
+  port: 22
+  routingKey: server-a2
+---
+apiVersion: skupper.io/v2alpha1
+kind: Connector
+metadata:
+  name: server-a3
+spec:
+  host: 192.168.8.103
+  port: 22
+  routingKey: server-a3
diff --git a/documentation/modules/ROOT/assets/resources/ocp-commands.sh b/documentation/modules/ROOT/assets/resources/ocp-commands.sh
@@ -0,0 +1,6 @@
+for i in cloud/net-a/*; do
+    echo "cat << EOF > ${i}";
+    cat "${i}"
+    echo "EOF"
+    echo
+done
diff --git a/documentation/modules/ROOT/nav.adoc b/documentation/modules/ROOT/nav.adoc
@@ -7,19 +7,22 @@
 ** xref:02-architecture.adoc#tech_stack[{module}.{counter:submodule2}. Technology stack]
 ** xref:02-architecture.adoc#in_depth[{module}.{counter:submodule2}. An in-depth look at the solution's architecture]
 ** xref:02-architecture.adoc#more_tech[{module}.{counter:submodule2}. More about the technology stack]
+** xref:02-architecture.adoc#walkthrough_overview[{module}.{counter:submodule2}. Walkthrough overview]
 
 * xref:03-demo.adoc[{counter:module}. See the Solution in Action]
 ** xref:03-demo.adoc#_before_running_the_solution[{module}.{counter:submodule3}. Before runing the solution]
 ** xref:03-demo.adoc#_walkthrough[{module}.{counter:submodule3}. Walkthrough]
-*** xref:03-demo.adoc#_downloading_resources_needed[{module}.{counter:submodule3}. Downloading resources needed]
-*** xref:03-demo.adoc#_installing_red_hat_ansible_automation_platform[{module}.{counter:submodule3}. Installing AAP]
-*** xref:03-demo.adoc#_configuring_your_ansible_automation_platform_instance[{module}.{counter:submodule3}. Configuring AAP]
+*** xref:03-demo.adoc#_installing_the_red_hat_service_interconnect_command_line_tool[{module}.{counter:submodule3}. Installing the Red Hat Service Interconnect command line tool]
 *** xref:03-demo.adoc#_installing_red_hat_service_interconnect_on_red_hat_openshift[{module}.{counter:submodule3}. Installing RHSI on OCP]
 *** xref:03-demo.adoc#_connecting_the_third_party_networks[{module}.{counter:submodule3}. Connecting Third Party Networks]
+*** xref:03-demo.adoc#_installing_red_hat_ansible_automation_platform[{module}.{counter:submodule3}. Installing AAP]
+*** xref:03-demo.adoc#_configuring_your_ansible_automation_platform_instance[{module}.{counter:submodule3}. Configuring AAP]
 *** xref:03-demo.adoc#_validating_the_scenario[{module}.{counter:submodule3}. Validating the scenario]
 ** xref:03-demo.adoc#_conclusion[{module}.{counter:submodule3}. Conclusion]
 
 
 * xref:developer-resources.adoc[{counter:module}. Developer Resources]
 
 * https://redhat-solution-patterns.github.io/solution-patterns/patterns.html[Explore Red Hat Solution Patterns^]
+
+
diff --git a/documentation/modules/ROOT/pages/01-pattern.adoc b/documentation/modules/ROOT/pages/01-pattern.adoc
@@ -14,7 +14,7 @@ their server's infrastructure.
 image::story_diagram.png[Scenario]
 
 These organizations need an easy way to expose their target servers to be managed by the trusted partner,
-and they do not want to allocate extra resources to change their network infrastructure.
+and they do not want to allocate extra resources or change their network infrastructure.
 
 == The Solution
 
diff --git a/documentation/modules/ROOT/pages/02-architecture.adoc b/documentation/modules/ROOT/pages/02-architecture.adoc
@@ -42,8 +42,7 @@ RHSI link, coming from the third-party network. Once the {rhsi} link is establis
 and security, a selected set of servers, running in the third-party network, will be exposed by an RHSI instance running
 within the third-party network, into the third-party specific namespace on the {ocp} cluster.
 
-The respective servers are then exposed as Kubernetes services within the third-party namespace, where the AAP instance
-will be able to communicate with them via SSH transparently through RHSI.
+The respective servers are then exposed as Kubernetes services within the third-party namespace, allowing the AAP instance to communicate with them via SSH transparently through RHSI.
 
 Distinct inventories will be created inside AAP, for each third-party network, representing the servers to be managed.
 
@@ -69,11 +68,23 @@ image::architecture_alternative_diagram.png[Alternative architecture]
 [#more_tech]
 == About the Technology Stack
 
-{rhsi} provides access to selected workloads running in the third-party network.
+{rhsi} provides access to selected workloads running in the third-party network. +
 In this solution pattern, we illustrate two third-party networks being managed by AAP.
 One of them, represented as *_Third-party network A_* has an RHSI instance running on a *{rhel}* (RHEL) machine.
 
 The following one, represented as *_Third-party network B_* has an RHSI instance running using *Podman*.
 
-It is important to mention that {rhsi} (version 2+) runs on Kubernetes clusters,
+It is important to mention that {rhsi} (version 2+) runs on any Kubernetes cluster (like {ocp}),
 {rhel} and using Podman or Docker container engines.
+
+[#walkthrough_overview]
+== Walkthrough overview
+
+In the next section, we will walk you through the setup of this solution pattern. This walkthrough guide will cover just a subset of the architecture diagram presented earlier.
+
+It explains what needs to be done in order to:
+
+* Install {rhsi} version 2 on a {ocp} cluster
+* Create a functional {rhsi} Site on {ocp} to provide access to the _Third-party Network A_ hostnames
+* Create and install a {rhsi} Site Bundle inside the _Third-party Network A_
+* Provide a minimum set of configuration needed on a {aap} installation running on {ocp}
diff --git a/documentation/modules/ROOT/pages/03-demo.adoc b/documentation/modules/ROOT/pages/03-demo.adoc
diff --git a/documentation/modules/ROOT/pages/index.adoc b/documentation/modules/ROOT/pages/index.adoc
