Skip to content

fix: citation helm deployment - #40

Merged
jburke-cadc merged 2 commits into
opencadc:mainfrom
at88mph:deploy-citation
Jul 24, 2026
Merged

jburke-cadc merged 2 commits into
opencadc:mainfrom
at88mph:deploy-citation

Conversation

@at88mph

@at88mph at88mph commented May 23, 2026

Copy link
Copy Markdown
Member

Add a Helm Chart to deploy the citation application. Also included an in-page cache to alleviate multiple registry calls from the browser.

Changes

  • New Helm Chart in the citation/helm folder
    • ArgoCD ready
  • Small change to only call registry once per lookup and cache for faster page API access

@at88mph

at88mph commented Jul 21, 2026

Copy link
Copy Markdown
Member Author

@jburke-cadc @WenbinWL Could one of you review this? Once accepted I can complete that Story and we can deploy this to the new Kubernetes Cluster.

@WenbinWL

WenbinWL commented Jul 22, 2026 •

Copy link
Copy Markdown
Contributor

A few concerns:

  1. I think we should confirm this image repository before merging.
    @pdowler mentioned that images.opencadc.org is intended for open-source images, mostly a community for external users, while internal images should stay on bucket.canfar.net with imagePullSecrets.
    I also cannot verify that an images.opencadc.org/canfar project is available.
    Question: Should this chart default to bucket.canfar.net/citation, or should the repository be left empty/overridden only by deployent values?

e.g.:

image:
  repository: ""
  tag: ""

@WenbinWL

WenbinWL commented Jul 22, 2026 •

Copy link
Copy Markdown
Contributor
  1. The chart appVersion is 1.16.0, but the default image tag is v1.0.0 and the README says the tag should match appVersion. This will render images.opencadc.org/canfar/citation:v1.0.0(if exists) instead of using 1.16.0.
    Are we okay with not to align appVersion, image.tag, and the documented build tag?

@WenbinWL

WenbinWL commented Jul 22, 2026 •

Copy link
Copy Markdown
Contributor
  1. Keel staging registry may need to specify DOI lookups at the new DOI deployment
    registry looksup for: ivo://cadc.nrc.ca/doi
    I didn't notice there was a service mapping which can point the registry to the actual capabilities endpoint:
- id: "ivo://cadc.nrc.ca/doi"
     url: "https://staging.canfar.net/doi/capabilities"

my understanding:
Since citation resolves DOI endpoints through ivo://cadc.nrc.ca/doi, the Keel staging registry values also need to publish the DOI service entry for the new staging DOI deployment. Otherwise this page may continue resolving to the old ws-cadc.canfar.net DOI service even after deploying the new chart.

@pdowler

pdowler commented Jul 23, 2026

Copy link
Copy Markdown
Member

I am strongly against publishing any images from this repo to images.opencadc.org.

The fact that this repo is in the opencadc organisation at all was a short cut I already regret.

@at88mph

at88mph commented Jul 23, 2026

Copy link
Copy Markdown
Member Author
  1. Keel staging registry may need to specify DOI lookups at the new DOI deployment
    registry looksup for: ivo://cadc.nrc.ca/doi
    I didn't notice there was a service mapping which can point the registry to the actual capabilities endpoint:
- id: "ivo://cadc.nrc.ca/doi"
     url: "https://staging.canfar.net/doi/capabilities"

my understanding: Since citation resolves DOI endpoints through ivo://cadc.nrc.ca/doi, the Keel staging registry values also need to publish the DOI service entry for the new staging DOI deployment. Otherwise this page may continue resolving to the old ws-cadc.canfar.net DOI service even after deploying the new chart.

Right. There is what I would think is a bug. Citation is a client application that calls the Registry using a provided baseURL, which is pulled from the incoming request origin:

        // Instantiate controller for Data Citation List page
        citation_js = new cadc.web.citation.Citation({baseURL: window.location.origin})
        citation_js.init()

We should likely have configuration passed in like other applications/services. On deployment, this application will depend on a Registry accessible from this same domain. The actual lookup is hard-coded:

      return _getCachedServiceURL(
          'ivo://cadc.nrc.ca/doi',
          'http://www.opencadc.org/std/doi#instances-1.0',
          'vs:ParamHTTP',
          'cookie'
      )

Is that passable for a first release?

@at88mph

at88mph commented Jul 23, 2026

Copy link
Copy Markdown
Member Author

Is this because the doi and citation images won't be used by anybody else, @pdowler? I've moved this deployment's image to bucket.canfar.net until we get a better Harbor running.

@WenbinWL The suggested changes are in place

@WenbinWL

Copy link
Copy Markdown
Contributor

Looks good to me. Thank you @at88mph.

@at88mph

at88mph commented Jul 23, 2026

Copy link
Copy Markdown
Member Author

Thanks @WenbinWL . Do you have merge permission?

@jburke-cadc
jburke-cadc merged commit 69de809 into opencadc:main Jul 24, 2026
1 check passed
@at88mph
at88mph deleted the deploy-citation branch July 24, 2026 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants