Development Setup

Prereq

1. Go 1.17
2. Go Fresh

   go install github.com/pilu/fresh
   

3. K3D (required for running locally)

Start

1. Run argo workflow in k3d

   scripts/argo.local.sh --username ARTIFACTORY_USERNAME --password ARTIFACTORY_PASSWORD
   

   This will start a k3d cluster and deploy minimal Argo Workflow. It also port-forward 2746 to localhost

   Note: ARTIFACTORY_USERNAME and ARTIFACTORY_PASSWORD are required to pull the Argo Workflow image from Artifactory

   https://rndwiki-pro.its.hpecorp.net/display/CSMTemp/Client+Authentication#ClientAuthentication-Docker

2. Modify cluster-admin file

   Patch the cluster-admin file by running the following command

    kubectl patch ClusterRoleBindings/cluster-admin --patch "$(cat cluster-admin-patch.yaml)"

3. Create and update .env file

   Copy .env.example file to .env file

   cp .env.example .env

   Then replace the contents of the .env with the following block:

   SERVER_PORT=3000
   ENV=development
   ARGO_TOKEN=eyJhbGciOiJSUzI1NiIsImtpZCI6Ijk4dWFiYTF4ZU56SFA2OGFETWtwVXNlUGJhekdfV3B4NE9zYnpOVWZFZlkifQ.eyJpc3MiOiJrdWJlcm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9uYW1lc3BhY2UiOiJhcmdvIiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZWNyZXQubmFtZSI6ImFyZ28tc2VydmVyLXRva2VuLThzMmZkIiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQubmFtZSI6ImFyZ28tc2VydmVyIiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQudWlkIjoiNDRkMjZkYzUtM2JhNi00Nzc1LTk3NjgtYWMzYmI4ZDUwNjEwIiwic3ViIjoic3lzdGVtOnNlcnZpY2VhY2NvdW50OmFyZ286YXJnby1zZXJ2ZXIifQ.nGIrVeWodcv3TdvP9A5FpAH1mjUUAzdVyiRB6zZ65Nd_qRsAgKMJaDoasIEaCTG3O1NqNH-L6EBmK4_wMkx5hCV4zgShkWyDwmQBGccL52-0g9r2EPzZUrK2djRoQFNBAVHhYdL8kcUpNxl-nKLBrLCNyinGnHRWblRmt021nZZsE62ljXj1TDmNRbg71oC94tnBeGi4j3Iza9KBf8cTjTeKYVyDLQrd6gGQuUpWZ9l4vfK7X4Ke8dDEuWtWkxDZgnNewQLZmPP7K-QUZEbNlL82r4KJSExaCJmBZfPx21QH0bSJbrl6Xr1m22W1OqTCEQEsNv2uIm7nV4A2vmhdZA
   ARGO_SERVER_URL=localhost:2746
   API_GATEWAY_URL=https://api-gw-service-nmn.local
   

4. Run server

   One time setup: copy and rename .env.example to .env

   scripts/runDev.sh
   

   Automatically rebuild and launch API server when a change is made. Fresh configuration file: {rootDir}/runner.conf

5. Load swagger and Argo

   These sites are on localhost and will only open with the previous scripts running

   • Swagger URL
   • Argo URL

Optional Steps

• Update swagger

  scripts/swagger.gen.sh
  

  Note: This script will try to update docs/swagger.md if nodejs is installed. Otherwise, it will only update docs/swagger.yaml

Versioning

The .version file needs to be updated every time you update this repository, in the following way:

1. If you are updating this repo to be used by the next version of CSM (major or minor update to CSM, but not patch), then increment the major version in the .version file as well.
2. Use the version you defined in .version and update the cray-nls-charts as well.

The version numbers to be used must follow the format given in the table below. Note that the format is different for CSM 1.4.x releases because this convention is decided after the CSM 1.4.0 release but before the 1.5.0 release, so it was not possible to change the convention for a previously released product.

CSM Version	.version file in this repo	Helm chart version in cray-nls-charts
1.4.x	0.(10+x).y	2.(10+x).y
1.5.x	3.(1+x).y	3.(1+x).y
1.6.x	4.x.y	4.x.y

Reference

Dependency Injection

• uber fx

Clean gin template

Argo Workflow

K3D