fixing susanoo references with netapp-openshift-console-trident

Author: romdalf

BUILD.md

@@ -29,7 +29,7 @@ Log in as user:
 Use the 'oc' command line interface:
   $ eval $(crc oc-env)
   $ oc login -u developer https://api.crc.testing:6443
-romv@romv-mac-0 susanoo-openshift % 
+romv@romv-mac-0 netapp-openshift-console-trident % 
 ``` 
 
 - ensure the following dependencies are met:
@@ -40,15 +40,15 @@ romv@romv-mac-0 susanoo-openshift %
 
 - clone this repository
 ```
-git clone https://github.com/NetApp/susanoo-openshift.git
+git clone https://github.com/NetApp/netapp-openshift-console-trident.git
 ```
 - install all the code dependencies:
 ```
 yarn install
 ```
 expected output:
 ```
-romv@romv-mac-0 susanoo-openshift % yarn install
+romv@romv-mac-0 netapp-openshift-console-trident % yarn install
 yarn install v1.22.22
 [1/4] 🔍  Resolving packages...
 [2/4] 🚚  Fetching packages...
@@ -70,7 +70,7 @@ yarn run start
 ```
 expected output:
 ```
-romv@romv-mac-0 susanoo-openshift % yarn start  
+romv@romv-mac-0 netapp-openshift-console-trident % yarn start  
 yarn run v1.22.22
 $ yarn webpack serve --progress
 $ node -r ts-node/register ./node_modules/.bin/webpack serve --progress
@@ -111,7 +111,7 @@ oc login <cluster_url>
 ```
 expected output:
 ```
-romv@romv-mac-0 susanoo-openshift % oc login -u kubeadmin
+romv@romv-mac-0 netapp-openshift-console-trident % oc login -u kubeadmin
 Logged into "https://api.crc.testing:6443" as "kubeadmin" using existing credentials.
 
 You have access to 65 projects, the list has been suppressed. You can list all projects with 'oc projects'

CHANGELOG.md

@@ -1,4 +1,4 @@
 # Change Log
 
 All notable changes to this project will be documented in the
-[Releases](https://github.com/NetApp/susanoo/releases) page on GitHub.
+[Releases](https://github.com/NetApp/netapp-openshift-console-trident/releases) page on GitHub.

DOCS.md

@@ -1,72 +1,8 @@
 # netapp-openshift-console-trident
 
-This project is currently in a pre-release phase and requires an early access legal agreement to deploy and use netapp-openshift-console-trident. 
-
-## netapp-openshift-console-trident container image access
-The container image is available via our GitHub organization's container registry as a private package with the access token as an image pull secret. 
-
-### Create a Kubernetes Secret for ```docker-registry```
-
-The required details to create the secret are:
-- a GitHub username
-- a generated GitHub Token
-
-Then:
-* First, create the ```namespace``` or ```project``` for netapp-openshift-console-trident:
-  ```
-  oc new-project netapp-openshift-console-trident
-  ```
-
-* Then, run the following command with the provided details:
-  ```
-  oc -n netapp-openshift-console-trident create secret docker-registry ghcr-netapp-openshift-console-trident-secret --docker-server=https://ghcr.io --docker-username=$YOUR_GITHUB_USERNAME --docker-password=$YOUR_GITHUB_TOKEN
-  ```
-
-> [!NOTE]  
-> The secret name is ```ghcr-netapp-openshift-console-trident-secret``` and will be used by the Helm Charts. Changing the name might fail the deployment.
-
-The secret could also be created using a YAML manfiest. Here is the process: 
-
-* Encode your GitHub username with the access token:
-  ```
-  echo -n "myusername:mysecretoken" | base64
-  ```
-  Expected output:
-  ```
-  bXl1c2VybmFtZTpteXNlY3JldG9rZW4=
-  ```
-
-* Create a ```netapp-openshift-console-trident.json``` file for future reference with the following details:
-  ```
-  {"auths":{"ghcr.io":{"auth": "bXl1c2VybmFtZTpteXNlY3JldG9rZW4"}}}
-  ```
-* Encode the content:
-  ```
-  echo -n "{"auths":{"ghcr.io":{"auth": "bXl1c2VybmFtZTpteXNlY3JldG9rZW4"}}}" | base64
-  ```
-  expected output:
-  ```
-  e2F1dGhzOntnaGNyLmlvOnthdXRoOiBiWGwxYzJWeWJtRnRaVHB0ZVhObFkzSmxkRzlyWlc0fX19
-  ```
-* Then create a secret YAML manifest ```ghcr-netapp-openshift-console-trident-secret.yaml```:
-  ```YAML
-  apiVersion: v1
-  kind: Secret
-  metadata:
-    name: ghcr-netapp-openshift-console-trident-secret
-    namespace: netapp-openshift-console-trident
-  data:
-    .dockerconfigjson: e2F1dGhzOntnaGNyLmlvOnthdXRoOiBiWGwxYzJWeWJtRnRaVHB0ZVhObFkzSmxkRzlyWlc0fX19
-  type: kubernetes.io/dockerconfigjson
-  ```
-* Finally, push the manifest to Kubernetes:
-  ```
-  oc create -f ghcr-netapp-openshift-console-trident-secret.yaml
-  ```
-
-> [!NOTE]
-> While the access Token is **read only**, it is a good practice to ***not be saved*** these files in a Git repository as it contains credentials.
+This project is currently in a pre-release phase and requires an Early Access Program agreement granting a read-only access token to deploy the netapp-openshift-console-trident plugin on your Red Hat OpenShift cluster.  
 
+Reach out to the NetApp Innovation Labs team to know more.  
 
 ## Deployment with Helm
 
@@ -79,19 +15,23 @@ The provided Helm Charts allows you to deploy easily netapp-openshift-console-tr
 
 * Then, when in the ```netapp-openshift-console-trident``` folder, run:
   ```
-  helm install netapp-openshift-console-trident charts/netapp-openshift-console-trident -n netapp-openshift-console-trident --create-namespace --set plugin.image=ghcr.io/netapp/netapp-openshift-console-trident:25.6.25
+  helm install netapp-openshift-console-trident . -n netapp-openshift-console-trident --create-namespace --set plugin.image=ghcr.io/netapp/netapp-openshift-console-trident:25.6.25 --set plugin.imageCredentials.registry=ghcr.io --set plugin.imageCredentials.username=<username> --set plugin.imageCredentials.token=<token> 
   ```
   Expected output:
   ```
   Release "netapp-openshift-console-trident" does not exist. Installing it now.
   NAME: netapp-openshift-console-trident
-  LAST DEPLOYED: Tue Mar 18 20:07:27 2025
+  LAST DEPLOYED: Wed Jun 11 11:38:31 2025
   NAMESPACE: netapp-openshift-console-trident
   STATUS: deployed
   REVISION: 1
   TEST SUITE: None
   ```
 
+> [!NOTE]
+> While the access Token is **read only**, it is a good practice to ***not be saved*** these files in a Git repository as it contains credentials.
+  ```
+
   The only variable is ```plugin.image=ghcr.io/netapp/netapp-openshift-console-trident:25.6.25``` corresponding to the desired version to deploy. At the current stage, the following version(s) are available:  
   - 25.6.25
 

README.md

@@ -12,7 +12,7 @@ netapp-openshift-console-trident deploys as a native Red Hat OpenShift console p
 ## Pre-requisites and Deployment
 
 This project is currently in a pre-release phase and requires an Early Access Program agreement granting access token to deploy the plugin on your Red Hat OpenShift cluster.   
-The netapp-openshift-console-protect plugin is compatible with Red Hat OpenShift Container Platform 4.14, 4.15, 4.16, and 4.17. 
+The netapp-openshift-console-trident plugin is compatible with Red Hat OpenShift Container Platform **4.14, 4.15, 4.16, and 4.17**. 
 
 Documentation is available [here](DOCS.md).
 

charts/netapp-openshift-console-trident/templates/_helpers.tpl

@@ -1,24 +1,24 @@
 {{/*
 Expand the name of the chart.
 */}}
-{{- define "susanoo.name" -}}
+{{- define "netapp-openshift-console-trident.name" -}}
 {{- default (default .Chart.Name .Release.Name) .Values.plugin.name | trunc 63 | trimSuffix "-" }}
 {{- end }}
 
 
 {{/*
 Create chart name and version as used by the chart label.
 */}}
-{{- define "susanoo.chart" -}}
+{{- define "netapp-openshift-console-trident.chart" -}}
 {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
 {{- end }}
 
 {{/*
 Common labels
 */}}
-{{- define "susanoo.labels" -}}
-helm.sh/chart: {{ include "susanoo.chart" . }}
-{{ include "susanoo.selectorLabels" . }}
+{{- define "netapp-openshift-console-trident.labels" -}}
+helm.sh/chart: {{ include "netapp-openshift-console-trident.chart" . }}
+{{ include "netapp-openshift-console-trident.selectorLabels" . }}
 {{- if .Chart.AppVersion }}
 app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
 {{- end }}
@@ -28,26 +28,26 @@ app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{/*
 Selector labels
 */}}
-{{- define "susanoo.selectorLabels" -}}
-app: {{ include "susanoo.name" . }}
-app.kubernetes.io/name: {{ include "susanoo.name" . }}
+{{- define "netapp-openshift-console-trident.selectorLabels" -}}
+app: {{ include "netapp-openshift-console-trident.name" . }}
+app.kubernetes.io/name: {{ include "netapp-openshift-console-trident.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
-app.kubernetes.io/part-of: {{ include "susanoo.name" . }}
+app.kubernetes.io/part-of: {{ include "netapp-openshift-console-trident.name" . }}
 {{- end }}
 
 {{/*
 Create the name secret containing the certificate
 */}}
-{{- define "susanoo.certificateSecret" -}}
-{{ default (printf "%s-cert" (include "susanoo.name" .)) .Values.plugin.certificateSecretName }}
+{{- define "netapp-openshift-console-trident.certificateSecret" -}}
+{{ default (printf "%s-cert" (include "netapp-openshift-console-trident.name" .)) .Values.plugin.certificateSecretName }}
 {{- end }}
 
 {{/*
 Create the name of the service account to use
 */}}
-{{- define "susanoo.serviceAccountName" -}}
+{{- define "netapp-openshift-console-trident.serviceAccountName" -}}
 {{- if .Values.plugin.serviceAccount.create }}
-{{- default (include "susanoo.name" .) .Values.plugin.serviceAccount.name }}
+{{- default (include "netapp-openshift-console-trident.name" .) .Values.plugin.serviceAccount.name }}
 {{- else }}
 {{- default "default" .Values.plugin.serviceAccount.name }}
 {{- end }}
@@ -56,16 +56,16 @@ Create the name of the service account to use
 {{/*
 Create the name of the patcher
 */}}
-{{- define "susanoo.patcherName" -}}
-{{- printf "%s-patcher" (include "susanoo.name" .) }}
+{{- define "netapp-openshift-console-trident.patcherName" -}}
+{{- printf "%s-patcher" (include "netapp-openshift-console-trident.name" .) }}
 {{- end }}
 
 {{/*
 Create the name of the service account to use
 */}}
-{{- define "susanoo.patcherServiceAccountName" -}}
+{{- define "netapp-openshift-console-trident.patcherServiceAccountName" -}}
 {{- if .Values.plugin.patcherServiceAccount.create }}
-{{- default (printf "%s-patcher" (include "susanoo.name" .)) .Values.plugin.patcherServiceAccount.name }}
+{{- default (printf "%s-patcher" (include "netapp-openshift-console-trident.name" .)) .Values.plugin.patcherServiceAccount.name }}
 {{- else }}
 {{- default "default" .Values.plugin.patcherServiceAccount.name }}
 {{- end }}

charts/netapp-openshift-console-trident/templates/configmap.yaml

@@ -4,7 +4,7 @@ metadata:
   name: {{ .Values.plugin.name }}-configmap
   namespace: {{ .Release.Namespace }}
   labels:
-    {{- include "susanoo.labels" . | nindent 4 }}
+    {{- include "netapp-openshift-console-trident.labels" . | nindent 4 }}
 data:
   nginx.conf: |
     error_log /dev/stdout info;

charts/netapp-openshift-console-trident/templates/consoleplugin.yaml

@@ -6,11 +6,11 @@ metadata:
   labels:
     {{- include "susanoo.labels" . | nindent 4 }}
 spec:
-  displayName: 'Susanoo by NetApp'
+  displayName: 'netapp-openshift-console-trident'
   backend:
     type: Service
     service:
-      name: {{ template "susanoo.name" . }}
+      name: {{ template "netapp-openshift-console-trident.name" . }}
       namespace: {{ .Release.Namespace }}
       port: 9443
       basePath: '/'

charts/netapp-openshift-console-trident/templates/deployment.yaml

@@ -4,22 +4,22 @@ metadata:
   name: {{ .Values.plugin.name }}-deployment
   namespace: {{ .Release.Namespace }}
   labels:
-    {{- include "susanoo.labels" . | nindent 4 }}
+    {{- include "netapp-openshift-console-trident.labels" . | nindent 4 }}
     app.openshift.io/runtime-namespace: {{ .Release.Namespace }}
 spec:
   replicas: {{ .Values.plugin.replicas }}
   selector:
     matchLabels:
-      {{- include "susanoo.selectorLabels" . | nindent 6 }}
+      {{- include "netapp-openshift-console-trident.selectorLabels" . | nindent 6 }}
   template:
     metadata:
       labels:
-            {{- include "susanoo.labels" . | nindent 8 }}
+            {{- include "netapp-openshift-console-trident.labels" . | nindent 8 }}
     spec:
       imagePullSecrets:
         - name: {{ .Values.plugin.name }}-registry-secret
       containers:
-        - name: {{ template "susanoo.name" . }}
+        - name: {{ template "netapp-openshift-console-trident.name" . }}
           image: {{ required "Plugin image must be specified!" .Values.plugin.image }}
           ports:
             - containerPort: {{ .Values.plugin.port }}
@@ -34,7 +34,7 @@ spec:
             - name: console-serving-cert
               readOnly: true
               mountPath: /var/serving-cert
-            - name: susanoo-nginx-config
+            - name: netapp-openshift-console-trident-nginx-config
               readOnly: true
               mountPath: /etc/nginx/nginx.conf
               subPath: nginx.conf
@@ -43,7 +43,7 @@ spec:
           secret:
             secretName: console-serving-cert
             defaultMode: 420
-        - name: susanoo-nginx-config
+        - name: netapp-openshift-console-trident-nginx-config
           configMap:
             name: {{ .Values.plugin.name }}-configmap
             defaultMode: 420