Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Usage command in README does not work

Open
  • Is something wrong?
#41 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
yaml
Domain
devops, documentation

Research direction

Open README and locate the usage command containing oc process and the appassessment-template.yaml URL. Update the command with --local=true and document the required OpenShift namespace admin privileges; verify the README reflects both the successful command and the permission limitation.

Written by the indexing model from the issue text.

Description

The following command given in the README does not work as intended:

oc process -f https://raw.githubusercontent.com/bcgov/AppAssessment/main/template/appassessment-template.yaml -p LICENSE_PLATE=<License Plate> -p CLUSTER_NAME="<Cluster Name>" -p APP_ASSESSMENT_IMAGE=image-registry.openshift-image-registry.svc:5000/bcgov/app-assessment | oc apply -f -

When used after filling in the correct parameters, the following error occurs:

error: unable to process template: the namespace of the provided object does not match the namespace sent on the request
error:  no objects passed to apply

As noted in a RocketChat post, by adding the flag --local=true to the oc process part of the command, this issue is resolved. The fixed command looks as such:

oc process -f https://raw.githubusercontent.com/bcgov/AppAssessment/main/template/appassessment-template.yaml -p LICENSE_PLATE=<License Plate> -p CLUSTER_NAME="<Cluster Name>" -p APP_ASSESSMENT_IMAGE=image-registry.openshift-image-registry.svc:5000/bcgov/app-assessment --local=true | oc apply -f -

Additionally, it should be noted somewhere in the README that this requires admin privileges to the namespace in OpenShift, as if you try to run the fixed command without them, you get the following error after creating a few of the objects:

Error from server (Forbidden): error when retrieving current configuration of:
Resource: "rbac.authorization.k8s.io/v1, Resource=rolebindings", GroupVersionKind: "rbac.authorization.k8s.io/v1, Kind=RoleBinding"
Name: "appassessment-view", Namespace: "<License Plate>-tools"
from server for: "STDIN": rolebindings.rbac.authorization.k8s.io "appassessment-view" is forbidden: User "<username>" cannot get resource "rolebindings" in API group "rbac.authorization.k8s.io" in the namespace "<License Plate>-tools"

I cannot create a PR for this as I do not have rights to publish to this repository, but I will leave it here for anyone trying to diagnose these issues in the future.

Dominant language
Python
Stars
7
Forks
3
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from bcgov/AppAssessment

All issues in bcgov/AppAssessment

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.