Update readme (openshift-online#2)

Signed-off-by: clyang82 <[email protected]>

Author: clyang82

Makefile

@@ -21,6 +21,9 @@ image_tag:=$(version)
 environment:=${USER}
 namespace:=ocm-${USER}
 
+# a tool for managing containers and images, etc. You can set it as docker
+container_tool ?= podman
+
 # In the development environment we are pushing the image directly to the image
 # registry inside the development cluster. That registry has a different name
 # when it is accessed from outside the cluster and when it is accessed from
@@ -77,7 +80,7 @@ help:
 
 # Encourage consistent tool versions
 OPENAPI_GENERATOR_VERSION:=5.4.0
-GO_VERSION:=go1.21.0
+GO_VERSION:=go1.21.
 
 ### Constants:
 version:=$(shell date +%s)
@@ -185,10 +188,10 @@ test-integration: install
 # Regenerate openapi client and models
 generate:
 	rm -rf pkg/api/openapi
-	podman build -t ams-openapi -f Dockerfile.openapi .
-	$(eval OPENAPI_IMAGE_ID=`podman create -t ams-openapi -f Dockerfile.openapi .`)
-	podman cp $(OPENAPI_IMAGE_ID):/local/pkg/api/openapi ./pkg/api/openapi
-	podman cp $(OPENAPI_IMAGE_ID):/local/data/generated/openapi/openapi.go ./data/generated/openapi/openapi.go
+	$(container_tool) build -t ams-openapi -f Dockerfile.openapi .
+	$(eval OPENAPI_IMAGE_ID=`$(container_tool) create -t ams-openapi -f Dockerfile.openapi .`)
+	$(container_tool) cp $(OPENAPI_IMAGE_ID):/local/pkg/api/openapi ./pkg/api/openapi
+	$(container_tool) cp $(OPENAPI_IMAGE_ID):/local/data/generated/openapi/openapi.go ./data/generated/openapi/openapi.go
 .PHONY: generate
 
 run: install
@@ -259,11 +262,11 @@ project:
 
 .PHONY: image
 image: cmds
-	podman build -t "$(external_image_registry)/$(image_repository):$(image_tag)" .
+	$(container_tool) build -t "$(external_image_registry)/$(image_repository):$(image_tag)" .
 
 .PHONY: push
 push: image
-	podman push "$(external_image_registry)/$(image_repository):$(image_tag)"
+	$(container_tool) push "$(external_image_registry)/$(image_repository):$(image_tag)"
 
 deploy-%: project %-template
 	$(oc) apply --filename="templates/$*-template.json" | egrep --color=auto 'configured|$$'
@@ -303,19 +306,19 @@ undeploy: \
 
 .PHONY: db/setup
 db/setup:
-	podman run --name psql-example -e POSTGRES_DB=$(db_name) -e POSTGRES_USER=$(db_user) -e POSTGRES_PASSWORD=$(db_password) -p $(db_port):5432 -d $(db_image)
+	$(container_tool) run --name psql-example -e POSTGRES_DB=$(db_name) -e POSTGRES_USER=$(db_user) -e POSTGRES_PASSWORD=$(db_password) -p $(db_port):5432 -d $(db_image)
 
 .PHONY: db/login
 db/login:
-	podman exec -it psql-example bash -c "psql -h localhost -U $(db_user) $(db_name)"
+	$(container_tool) exec -it psql-example bash -c "psql -h localhost -U $(db_user) $(db_name)"
 
 .PHONY: db/teardown
 db/teardown:
-	podman stop psql-example
-	podman rm psql-example
+	$(container_tool) stop psql-example
+	$(container_tool) rm psql-example
 
 crc/login:
 	@echo "Logging into CRC"
 	@crc console --credentials -ojson | jq -r .clusterConfig.adminCredentials.password | oc login --username kubeadmin --insecure-skip-tls-verify=true https://api.crc.testing:6443
-	@oc whoami --show-token | podman login --username kubeadmin --password-stdin "$(external_image_registry)"
+	@oc whoami --show-token | $(container_tool) login --username kubeadmin --password-stdin "$(external_image_registry)"
 .PHONY: crc/login

README.md

@@ -74,7 +74,7 @@ ocmexample=# \dt
  public | dinosaurs  | table | ocm_example_service
  public | events     | table | ocm_example_service
  public | migrations | table | ocm_example_service
-(2 rows)
+(3 rows)
 
 
 ```
@@ -83,43 +83,54 @@ ocmexample=# \dt
 
 ```shell
 
-$ make test
-$ make test-integration
+make test
+make test-integration
 
 ```
 
 ### Running the Service
 
-```
-./ocm-example-service serve
+```shell
+
+make run
+
 ```
 
 To verify that the server is working use the curl command:
 
-$ curl http://localhost:8000//api/ocm-example-service/v1/dinosaurs | jq
+```shell
+
+curl http://localhost:8000/api/ocm-example-service/v1/dinosaurs | jq
 
+```
 
 That should return a 401 response like this, because it needs authentication:
 
 ```
 {
   "kind": "Error",
   "id": "401",
-  "href": "//api/ocm-example-service/errors/401",
+  "href": "/api/ocm-example-service/errors/401",
   "code": "API-401",
   "reason": "Request doesn't contain the 'Authorization' header or the 'cs_jwt' cookie"
 }
 ```
 
 
 Authentication in the default configuration is done through the RedHat SSO, so you need to login with a Red Hat customer portal user in the right account (created as part of the onboarding doc) and then you can retrieve the token to use below on https://console.redhat.com/openshift/token
-To authenticate, use the ocm tool against your local service:
+To authenticate, use the ocm tool against your local service. The ocm tool is available on https://console.redhat.com/openshift/downloads
+
+#### Login to your local service
+```
+ocm login --token=${OCM_ACCESS_TOKEN} --url=http://localhost:8000
 
-### Get a new Dinosaur
+```
+
+#### Get a new Dinosaur
 This will be empty if no Dinosaur is ever created
 
 ```
-(base) ➜  ~ ocm get /api/ocm-example-service/v1/dinosaurs
+ocm get /api/ocm-example-service/v1/dinosaurs
 {
   "items": [],
   "kind": "DinosaurList",
@@ -129,10 +140,9 @@ This will be empty if no Dinosaur is ever created
 }
 ```
 
-### Post a new Dinosaur
+#### Post a new Dinosaur
 
 ```shell
-ocm login --token=${OCM_ACCESS_TOKEN} --url=http://localhost:8000
 
 ocm post /api/ocm-example-service/v1/dinosaurs << EOF
 {
@@ -142,6 +152,28 @@ EOF
 
 ```
 
+#### Get your Dinosaur
+
+```shell
+ocm get /api/ocm-example-service/v1/dinosaurs
+{
+  "items": [
+    {
+      "created_at":"2023-10-26T08:15:54.509653Z",
+      "href":"/api/ocm-example-service/v1/dinosaurs/2XIENcJIi9t2eBblhWVCtWLdbDZ",
+      "id":"2XIENcJIi9t2eBblhWVCtWLdbDZ",
+      "kind":"Dinosaur",
+      "species":"foo",
+      "updated_at":"2023-10-26T08:15:54.509653Z"
+    }
+  ],
+  "kind":"DinosaurList",
+  "page":1,
+  "size":1,
+  "total":1
+}
+```
+
 #### Run in CRC
 
 Use OpenShift Local to deploy to a local openshift cluster. Be sure to have CRC running locally: