From db30949b77775ff354bcc99a07c10e7e6e79f804 Mon Sep 17 00:00:00 2001
From: kurokobo <2920259+kurokobo@users.noreply.github.com>
Date: Mon, 26 Jul 2021 09:36:18 -0400
Subject: [PATCH] fix: update description about registry

---
 galaxy/README.md   | 16 +++++++++++-----
 registry/README.md | 12 ++++++++----
 2 files changed, 19 insertions(+), 9 deletions(-)

diff --git a/galaxy/README.md b/galaxy/README.md
index 5e34000..a433c8c 100644
--- a/galaxy/README.md
+++ b/galaxy/README.md
@@ -521,15 +521,14 @@ Push files in `collection-demo` to your SCM, and create new Project in AWX in st
 
 To use your Execution Environment on your Galaxy NG through AWX, Kubernetes have to be able to pull images from your Galaxy NG.
 
-To achieve this, create new user on Galaxy NG (of course `admin` works but not recommemded), create a `registries.yaml`, and then restart K3s.
+If the endpoint of the Galaxy NG you created is HTTPS with a Self-Signed Certificate, you need to disable SSL validation for the registry.
+
+To achieve this, create a `registries.yaml`, and then restart K3s.
 
 ```bash
 sudo tee /etc/rancher/k3s/registries.yaml <<EOF
 configs:
   galaxy.example.com:
-    auth:
-      username: awx
-      password: Galaxy123!
     tls:
       insecure_skip_verify: true
 EOF
@@ -547,4 +546,11 @@ sudo /usr/local/bin/crictl info
 sudo /usr/local/bin/crictl info | jq .config.registry
 ```
 
-Now you can push your Execution Environment to your Galaxy NG (as described above), register new Execution Environment on AWX, and use Execution Environment by specifing it in Global Default, Project, or Job Template.
+Now you can use Execution Environment on Galaxy NG through AWX as following.
+
+1. Push your Execution Environment to your Galaxy NG (as described above)
+2. Create Credential with `Container Registry` type on AWX for your Galaxy NG
+3. Register new Execution Environment on AWX
+4. Specify it as Execution Environment for the Job Template, Project Default, or Global Default.
+
+Once you start the Job Template, `imagePullSecrets` will be created from Credentials and assinged to the Pod, the image will be pulled, and the playbook will run on the Execution Environment.
diff --git a/registry/README.md b/registry/README.md
index 6754fbc..843dfc4 100644
--- a/registry/README.md
+++ b/registry/README.md
@@ -12,7 +12,7 @@ Deploying your private container registry on your K3s to use with AWX.
 - [Quick Testing](#quick-testing)
   - [Testing with Docker](#testing-with-docker)
   - [Digging into the Registry](#digging-into-the-registry)
-- [Use as Private Container Registry for K3s](#use-as-private-container-registry-for-k3s)
+- [Use as Private Container Registry for AWX or K3s](#use-as-private-container-registry-for-awx-or-k3s)
   - [Procedure](#procedure-1)
   - [Testing](#testing)
 
@@ -174,14 +174,18 @@ reg tags -k registry.example.com/reguser/whalesay
 reg rm -k registry.example.com/reguser/whalesay:latest
 ```
 
-## Use as Private Container Registry for K3s
+## Use as Private Container Registry for AWX or K3s
 
-This registry can also be registered as a private container registry for K3s. This is required procedure to use this registry to store images for AWX Execution Environment.
+This registry can be used not only as a registry to store Execution Environment for AWX, but also as a private registry for K3s.
 
 ### Procedure
 
 To achieve this, create a `registries.yaml` and restart K3s.
 
+Note that required `imagePullSecrets` will be automatically created by AWX once you register valid Credential for your registry on AWX. Therefore, the `auth` section is only necessary if Kubernetes pulls the image directly without AWX, as in the following [Testing](#testing) procedure.
+
+The `tls` section is required to disable SSL Verification as the endpoint is HTTPS with a Self-Signed Certificate.
+
 ```bash
 sudo tee /etc/rancher/k3s/registries.yaml <<EOF
 configs:
@@ -206,7 +210,7 @@ sudo /usr/local/bin/crictl info
 sudo /usr/local/bin/crictl info | jq .config.registry
 ```
 
-Alternatively, creating a secret and passing as `imagePullSecrets` to the Pod should also work.
+If you want Kubernetes to be able to pull images directly from this private registry, alternatively you can also manually create `imagePullSecrets` for the Pod instead of writing your credentials in `auth` in `registries.yaml`.
 
 ### Testing