diff --git a/cadc-registry-server/reg-applications.properties b/cadc-registry-server/reg-applications.properties index c6d6949..267fbc9 100644 --- a/cadc-registry-server/reg-applications.properties +++ b/cadc-registry-server/reg-applications.properties @@ -2,19 +2,5 @@ # This file maps resource identifiers to the base locations of UI pages and applications. # -## CADC applications - -# Deliberately fine grained at the moment, so better design can be done later -ivo://cadc.nrc.ca/passchg = https://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/en/auth/resetPassword.html -ivo://cadc.nrc.ca/passreset = https://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/en/auth/resetPassword.html -ivo://cadc.nrc.ca/acctrequest = https://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/en/auth/request.html -ivo://cadc.nrc.ca/acctupdate = https://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/en/auth/update.html - -# Most likely correct granularity of one that's per application -ivo://cadc.nrc.ca/groups = https://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/en/groups/ -ivo://cadc.nrc.ca/login = https://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/en/login.html -ivo://cadc.nrc.ca/download = https://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/en/download -ivo://cadc.nrc.ca/search = https://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/en/search - -## CANFAR applications -ivo://cadc.nrc.ca/canfar-dashboard = https://www.canfar.net/ +# Example: +# ivo://cadc.nrc.ca/ui/mycustomentry = https://example.com/mylink \ No newline at end of file diff --git a/cadc-registry-server/reg-resource-caps.properties b/cadc-registry-server/reg-resource-caps.properties index bc6f80f..1dc0692 100644 --- a/cadc-registry-server/reg-resource-caps.properties +++ b/cadc-registry-server/reg-resource-caps.properties @@ -3,198 +3,5 @@ # information. # -ivo://cadc.nrc.ca/reg = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/capabilities - -## storage inventory services -ivo://cadc.nrc.ca/cadc/minoc = https://ws-cadc.canfar.net/minoc/capabilities -ivo://cadc.nrc.ca/cadc/luskan = https://ws-cadc.canfar.net/luskan/capabilities - -ivo://cadc.nrc.ca/uvic/minoc = https://ws-uv.canfar.net/minoc/capabilities -ivo://cadc.nrc.ca/uvic/luskan = https://ws-uv.canfar.net/luskan/capabilities - -ivo://cadc.nrc.ca/sfu/minoc = https://ws-sf.canfar.net/minoc/capabilities -ivo://cadc.nrc.ca/sfu/luskan = https://ws-sf.canfar.net/luskan/capabilities - -ivo://cadc.nrc.ca/lsst/minoc = https://ws-uv.canfar.net/lsst/minoc/capabilities -ivo://cadc.nrc.ca/lsst/luskan = https://ws-uv.canfar.net/lsst/luskan/capabilities - -ivo://cadc.nrc.ca/global/baldur = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/baldur/capabilities -ivo://cadc.nrc.ca/global/luskan = https://cadc-west-01.canfar.net/luskan/capabilities -ivo://cadc.nrc.ca/global/raven = https://cadc-west-01.canfar.net/raven/capabilities - -## CADC services -ivo://cadc.nrc.ca/argus = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/argus/capabilities -ivo://cadc.nrc.ca/caom2ops = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/caom2ops/capabilities -ivo://cadc.nrc.ca/cred = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/cred/capabilities -ivo://cadc.nrc.ca/data = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/data/capabilities -ivo://cadc.nrc.ca/resolver = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/cadc-target-resolver/capabilities -ivo://cadc.nrc.ca/sia = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/sia/capabilities - -## CAOM-2.5 prototype services -ivo://cadc.nrc.ca/caom25/argus = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/caom25/argus/capabilities -ivo://cadc.nrc.ca/caom25/torkeep = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/caom25/torkeep/capabilities - -## archive metadata service(s) -ivo://cadc.nrc.ca/ams = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/ams/capabilities -ivo://cadc.nrc.ca/ams/alma = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/ams/alma/capabilities -ivo://cadc.nrc.ca/ams/cfht = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/ams/cfht/capabilities -ivo://cadc.nrc.ca/ams/cirada = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/ams/cirada/capabilities -ivo://cadc.nrc.ca/ams/dao = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/ams/dao/capabilities -ivo://cadc.nrc.ca/ams/drao = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/ams/drao/capabilities -ivo://cadc.nrc.ca/ams/eao = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/ams/eao/capabilities -ivo://cadc.nrc.ca/ams/gemini = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/ams/gemini/capabilities -ivo://cadc.nrc.ca/ams/ngvs = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/ams/ngvs/capabilities -ivo://cadc.nrc.ca/ams/maq = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/ams/maq/capabilities -ivo://cadc.nrc.ca/ams/mast = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/ams/mast/capabilities -ivo://cadc.nrc.ca/ams/omm = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/ams/omm/capabilities -ivo://cadc.nrc.ca/ams/shared = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/ams/shared/capabilities - -## CANFAR services -ivo://cadc.nrc.ca/doi = https://ws-cadc.canfar.net/doi/capabilities -ivo://cadc.nrc.ca/gms = https://ws-cadc.canfar.net/ac/capabilities -ivo://cadc.nrc.ca/ums = https://ws-cadc.canfar.net/ac/capabilities -ivo://cadc.nrc.ca/vault = https://cadc-west-01.canfar.net/vault/capabilities -ivo://cadc.nrc.ca/youcat = https://ws-uv.canfar.net/youcat/capabilities -ivo://cadc.nrc.ca/rdoi = https://ws-cadc.canfar.net/rdoi/capabilities - -## canfar science platform -ivo://cadc.nrc.ca/skaha = https://ws-uv.canfar.net/skaha/capabilities -ivo://cadc.nrc.ca/arc = https://ws-uv.canfar.net/arc/capabilities - -## external services -ivo://oats.inaf.it/gms = http://gms01.oats.inaf.it/ac/capabilities -ivo://oats.inaf.it/cred = http://gms01.oats.inaf.it/cred/capabilities -ivo://oats.inaf.it/vospace = http://space01.oats.inaf.it/vospace/capabilities - -ivo://unam.ens.edc/luskan = https://taos2-edc01.astrosen.unam.mx/luskan/capabilities -ivo://unam.ens.edc/minoc = https://taos2-edc01.astrosen.unam.mx/minoc/capabilities - -# MAST caom2 metadata service -ivo://mast.stsci.edu/caom2repo = https://mast.stsci.edu/portal/ArchivePartner/meta-service/capabilities - -# caom2 sandbox services -ivo://cadc.nrc.ca/sc2repo = https://sc2.canfar.net/sc2repo/capabilities -ivo://cadc.nrc.ca/sc2tap = https://sc2.canfar.net/sc2tap/capabilities -ivo://cadc.nrc.ca/sc2links = https://sc2.canfar.net/sc2links/capabilities -ivo://cadc.nrc.ca/sc2meta = https://sc2.canfar.net/sc2meta/capabilities -ivo://cadc.nrc.ca/sc2soda = https://sc2.canfar.net/sc2soda/capabilities - -# CADC data collections with caps - -ivo://cadc.nrc.ca/AICO = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/APASS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/APERO = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/ALMACA = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/BLAST = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/BNUNN = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/BRITE-Constellation = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/CFHT = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/CFHTMEGAPIPE = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/CFHTTERAPIX = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/CFHTUSER = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/CFHTWIRWOLF = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/CGPS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/DAO = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/DAOCADC = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/DAOPLATES = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/DRAO = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/EUCLID = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/EUCLID_DR1 = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/EUCLID.DR1 = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/EUCLID.Q1 = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/FUSE = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/GEMINI = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/GEMINICADC = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/GEMINIPROC = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/HSTHLA = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/IRIS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/JCMT = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/JCMTLP = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/JCMTLS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/LCO = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/LOTSS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/LSST.DP1 = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/MACHO = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/MOST = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/NEOSSAT = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/NGVS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/OMM = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/POSSUM = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/RACS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/SCUBA-LC = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/SPICE-RACS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/SUBARUCADC = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/TAOSII = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/UKIRT = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/VGPS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/VLASS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/WALLABY = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities - -# CADC mirror MAST data collections -ivo://cadc.nrc.ca/mirror/HST = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/mirror/JWST = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/capabilities -ivo://cadc.nrc.ca/mirror/TESS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/capabilities - -# CADC collections in the sandbox for testing -ivo://cadc.nrc.ca/test/AICO = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/APERO = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/BRITE-Constellation = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/CFHT = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/CFHTMEGAPIPE = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/DAO = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/DAOCADC = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/DDO = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/DRAO = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/EUCLID = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/EUCLID_DR1 = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/EUCLID.DR1 = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/EUCLID.Q1 = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/GEMINI = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/GEMINICADC = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/GEMINIPROC = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/HST = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/IRIS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/LCO = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/LOTSS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/LSST.DP1 = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/OMM = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/PHANGS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/POSSUM = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/VLASS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/TAOSII = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/ALMACA = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/NEOSSAT = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/NGVS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/RACS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/SCUBA-LC = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/SPICE-RACS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/SUBARUCADC = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/VLITE = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities -ivo://cadc.nrc.ca/test/WALLABY = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/cadc/sandbox/capabilities - -# MAQ collections in production -ivo://cadc.nrc.ca/ALMA = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/capabilities -ivo://cadc.nrc.ca/CHANDRA = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/capabilities -ivo://cadc.nrc.ca/NOAO = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/capabilities -ivo://cadc.nrc.ca/SUBARU = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/capabilities -ivo://cadc.nrc.ca/SDSS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/capabilities -ivo://cadc.nrc.ca/XMM = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/capabilities - -# MAQ collections in the sandbox for data engineer testing -ivo://cadc.nrc.ca/test/ALMA = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/sandbox/capabilities -ivo://cadc.nrc.ca/test/ESO = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/sandbox/capabilities -ivo://cadc.nrc.ca/test/CHANDRA = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/sandbox/capabilities -ivo://cadc.nrc.ca/test/NOAO = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/sandbox/capabilities -ivo://cadc.nrc.ca/test/SUBARU = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/sandbox/capabilities -ivo://cadc.nrc.ca/test/SDSS = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/sandbox/capabilities -ivo://cadc.nrc.ca/test/XMM = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/sandbox/capabilities -ivo://cadc.nrc.ca/test/ASKAP = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/sandbox/capabilities - -# externally curated collections in the sandbox -ivo://cadc.nrc.ca/ext/SKA = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/sandbox/capabilities -ivo://cadc.nrc.ca/ext/MeerKAT = https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/reg/maq/sandbox/capabilities - - -# Meetings service -ivo://cadc.nrc.ca/meetings = https://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/meetings/capabilities - +# Example: +# ivo://cadc.nrc.ca/service/mycustomentry = https://example.com/mylink/capabilities diff --git a/reg/helm/.helmignore b/reg/helm/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/reg/helm/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/reg/helm/Chart.yaml b/reg/helm/Chart.yaml new file mode 100644 index 0000000..1735f57 --- /dev/null +++ b/reg/helm/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: reg +description: Helm chart to deploy the reg IVOA Registry Service (reg/ application) on Kubernetes + +# A chart can be either an 'application' or a 'library' chart. +# +# Application charts are a collection of templates that can be packaged into versioned archives +# to be deployed. +# +# Library charts provide useful utilities or functions for the chart developer. They're included as +# a dependency of application charts to inject those utilities and functions into the rendering +# pipeline. Library charts do not define any templates and therefore cannot be deployed. +type: application + +# This is the chart version. This version number should be incremented each time you make changes +# to the chart and its templates, including the app version. +# Versions are expected to follow Semantic Versioning (https://semver.org/) +version: 1.2.1-rc.2 + +# This is the version number of the application being deployed. This version number should be +# incremented each time you make changes to the application. Versions are not expected to +# follow Semantic Versioning. They should reflect the version the application is using. +# It is recommended to use it with quotes. +appVersion: "1.2.1" diff --git a/reg/helm/README.md b/reg/helm/README.md new file mode 100644 index 0000000..ec1c969 --- /dev/null +++ b/reg/helm/README.md @@ -0,0 +1,126 @@ +# reg + +IVOA Registry Service Helm Chart + +| Chart | AppVersion | Type | +|:-----:|:----------:|:----:| +|1.2.0 | 1.2.1 | application | + +## Overview + +This Helm chart deploys the **reg** IVOA Registry Service on Kubernetes. + +The chart runs the application built from the [`reg/`](../reg/) directory in this repository — the deployable WAR, Docker image, and runtime configuration described in [`reg/README.md`](../reg/README.md). Other modules in the repository (`cadc-registry`, `cadc-vosi`, and so on) are libraries consumed by that application; this chart does not deploy them separately. + +The default container image is `images.opencadc.org/core/reg`, with tag matching the chart `appVersion` (aligned with [`reg/VERSION`](../reg/VERSION)). + +## Install + +From the repository root: + +```bash +helm install my-reg ./helm -f my-values.yaml +``` + +`application.serviceEntries` is required. A minimal values file: + +```yaml +application: + serviceEntries: + - id: "ivo://example.org/reg" + url: "https://example.org/my-service/capabilities" +``` + +## Configuration + +The chart renders a ConfigMap mounted at `/config` in the container. That produces the property files documented in [`reg/README.md`](../reg/README.md): + +| ConfigMap key | Purpose | +|---------------|---------| +| `catalina.properties` | Tomcat and proxy settings (`tomcat.connector.*`) | +| `reg-resource-caps.properties` | VOSI-enabled API entries (from `application.serviceEntries`) | +| `reg.properties` | OAI publishing authority (when `application.authority` is set) | +| `reg-applications.properties` | Web application entries (from `application.applicationEntries`, optional) | +| `cadc-log.properties` | Dynamic logging control (optional) | +| `cadc-vosi.properties` | VOSI availability admin and startup mode (optional) | + +### Application settings (`application.*`) + +- **`application.serviceEntries`** (required): list of `{ id, url }` pairs for VOSI-enabled APIs (web services). Rendered into `reg-resource-caps.properties` ([reg-resource-caps.properties](https://github.com/opencadc/reg/tree/main/reg#reg-resource-capsproperties-optional)). +- **`application.authority`**: optional IVOA authority for OAI publishing ([reg.properties](https://github.com/opencadc/reg/tree/main/reg#regproperties-optional)). +- **`application.vosi`**: VOSI admin users and startup mode (`Offline`, `ReadOnly`, `ReadWrite`). +- **`application.logging`**: users, groups, or DNs granted enhanced logging. +- **`application.applicationEntries`**: optional web application (user interface) feature ID to URL mappings ([reg-applications.properties](https://github.com/opencadc/reg/tree/main/reg#reg-applicationsproperites-optional-experimental)). + +### Public URL (`tomcat.connector`) + +When the service sits behind a reverse proxy, Tomcat needs the public URL clients use (equivalent to `X-Forwarded-Proto`, `X-Forwarded-Host`, and `X-Forwarded-Port`). These values are written to `catalina.properties` as `tomcat.connector.*` and affect VOSI capabilities output: `accessURL` hostnames are rewritten to match the request URL. + +Resolution order for each field: + +1. Explicit value in `tomcat.connector` +2. Auto-derived from `httpRoute` (if enabled) or `ingress` (if enabled) +3. Omitted when `proxyName` cannot be resolved + +**Internal-only deployment (defaults):** with `ingress.enabled=false`, `httpRoute.enabled=false`, `service.type=ClusterIP`, and empty `tomcat.connector` fields, no `tomcat.connector.*` properties are emitted. The service stays ClusterIP-only (reachable by Pods in the cluster) and Tomcat uses each incoming request URL as-is. + +Set `tomcat.connector` explicitly when the public URL differs from the ingress or HTTPRoute hostname — for example, when a CDN or external load balancer sits in front of the cluster. + +### Service exposure + +| Mechanism | Values key | Default | +|-----------|------------|---------| +| In-cluster only | `service.type: ClusterIP` | yes | +| Ingress | `ingress.enabled` | `false` | +| Gateway API HTTPRoute | `httpRoute.enabled` | `false` | + +When ingress or HTTPRoute is enabled and `tomcat.connector` fields are left empty, the public URL is derived from the configured hostnames. + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| application.logging | string | `nil` | | +| application.applicationEntries | list | `[]` | Web application (user interface) entries ([reg-applications.properties](https://github.com/opencadc/reg/tree/main/reg#reg-applicationsproperites-optional-experimental)) | +| application.authority | string | `""` | IVOA authority for OAI publishing ([reg.properties](https://github.com/opencadc/reg/tree/main/reg#regproperties-optional)) | +| application.serviceEntries | list | `[]` | VOSI-enabled API (web service) entries ([reg-resource-caps.properties](https://github.com/opencadc/reg/tree/main/reg#reg-resource-capsproperties-optional)) | +| application.vosi | string | `nil` | | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| fullnameOverride | string | `""` | | +| httpRoute | object | `{"annotations":{},"enabled":false,"hostnames":["chart-example.local"],"parentRefs":[{"name":"gateway","sectionName":"http"}],"rules":[{"matches":[{"path":{"type":"PathPrefix","value":"/headers"}}]}]}` | Expose the service via gateway-api HTTPRoute Requires Gateway API resources and suitable controller installed within the cluster (see: https://gateway-api.sigs.k8s.io/guides/) | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"images.opencadc.org/core/reg"` | | +| image.tag | string | `"1.2.1"` | | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts | list | `[]` | | +| ingress.tls | list | `[]` | | +| livenessProbe | string | `nil` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| podLabels | object | `{}` | | +| podSecurityContext | object | `{}` | | +| readinessProbe | string | `nil` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| service.port | int | `8080` | | +| service.type | string | `"ClusterIP"` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.automount | bool | `true` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `""` | | +| tolerations | list | `[]` | | +| tomcat.connector | object | `{"proxyName":"","proxyPort":"","scheme":""}` | Public URL for Tomcat behind a reverse proxy. Written to catalina.properties as tomcat.connector.* (X-Forwarded-Proto/Host/Port equivalent). Affects VOSI accessURL hostnames. Auto-derived from httpRoute or ingress when fields are empty; omitted for internal-only ClusterIP deployments. | +| tomcat.connector.proxyName | string | `""` | Public URL hostname. Auto-derived from httpRoute.hostnames[0] or ingress.hosts[0].host. | +| tomcat.connector.proxyPort | string | `""` | Public URL port. Auto-derived as 443 (https) or 80 (http). | +| tomcat.connector.scheme | string | `""` | Public URL scheme. Auto-derived as https (httpRoute or ingress with TLS) or http. | +| volumeMounts | list | `[]` | | +| volumes | list | `[]` | | diff --git a/reg/helm/templates/NOTES.txt b/reg/helm/templates/NOTES.txt new file mode 100644 index 0000000..37015c7 --- /dev/null +++ b/reg/helm/templates/NOTES.txt @@ -0,0 +1,44 @@ +OAI publishing is {{ ternary "enabled" "not enabled" (not (empty .Values.application.authority)) }}. + +1. Get the application URL by running these commands: +{{- if .Values.httpRoute.enabled }} +{{- if .Values.httpRoute.hostnames }} + export APP_HOSTNAME={{ .Values.httpRoute.hostnames | first }} +{{- else }} + export APP_HOSTNAME=$(kubectl get --namespace {{(first .Values.httpRoute.parentRefs).namespace | default .Release.Namespace }} gateway/{{ (first .Values.httpRoute.parentRefs).name }} -o jsonpath="{.spec.listeners[0].hostname}") + {{- end }} +{{- if and .Values.httpRoute.rules (first .Values.httpRoute.rules).matches (first (first .Values.httpRoute.rules).matches).path.value }} + echo "Visit http://$APP_HOSTNAME{{ (first (first .Values.httpRoute.rules).matches).path.value }} to use your application" + + NOTE: Your HTTPRoute depends on the listener configuration of your gateway and your HTTPRoute rules. + The rules can be set for path, method, header and query parameters. + You can check the gateway configuration with 'kubectl get --namespace {{(first .Values.httpRoute.parentRefs).namespace | default .Release.Namespace }} gateway/{{ (first .Values.httpRoute.parentRefs).name }} -o yaml' +{{- end }} +{{- else if .Values.ingress.enabled }} +{{- range $host := .Values.ingress.hosts }} + {{- range .paths }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }} + {{- end }} +{{- end }} +{{- else if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "reg.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch its status by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "reg.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "reg.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "reg.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT +{{- end }} + +{{- with .Values.application.serviceEntries }} +Configured entries are: + {{- range $index, $element := . }} + {{ $element.id }} = {{ $element.url }} + {{- end }} +{{- end }} diff --git a/reg/helm/templates/_helpers.tpl b/reg/helm/templates/_helpers.tpl new file mode 100644 index 0000000..aaa0c9a --- /dev/null +++ b/reg/helm/templates/_helpers.tpl @@ -0,0 +1,109 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "reg.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "reg.fullname" -}} +{{- if .Values.fullnameOverride }} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- $name := default .Chart.Name .Values.nameOverride }} +{{- if contains $name .Release.Name }} +{{- .Release.Name | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} +{{- end }} +{{- end }} +{{- end }} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "reg.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "reg.labels" -}} +helm.sh/chart: {{ include "reg.chart" . }} +{{ include "reg.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "reg.selectorLabels" -}} +app.kubernetes.io/name: {{ include "reg.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "reg.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "reg.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} + +{{/* +Resolve tomcat.connector settings for catalina.properties. +Returns YAML with scheme, proxyName, and proxyPort when proxyName can be resolved; empty otherwise. +*/}} +{{- define "reg.tomcatConnector" -}} +{{- $conn := .Values.tomcat.connector | default dict -}} +{{- $proxyName := $conn.proxyName -}} +{{- $scheme := $conn.scheme -}} +{{- $proxyPort := $conn.proxyPort -}} +{{- if not $proxyName -}} +{{- if .Values.httpRoute.enabled -}} +{{- if .Values.httpRoute.hostnames -}} +{{- $proxyName = index .Values.httpRoute.hostnames 0 -}} +{{- end -}} +{{- else if .Values.ingress.enabled -}} +{{- if .Values.ingress.hosts -}} +{{- $proxyName = (index .Values.ingress.hosts 0).host -}} +{{- end -}} +{{- end -}} +{{- end -}} +{{- if $proxyName -}} +{{- if not $scheme -}} +{{- if .Values.httpRoute.enabled -}} +{{- $scheme = "https" -}} +{{- else if .Values.ingress.enabled -}} +{{- if .Values.ingress.tls -}} +{{- $scheme = "https" -}} +{{- else -}} +{{- $scheme = "http" -}} +{{- end -}} +{{- else -}} +{{- $scheme = "https" -}} +{{- end -}} +{{- end -}} +{{- if not $proxyPort -}} +{{- if eq $scheme "https" -}} +{{- $proxyPort = 443 -}} +{{- else -}} +{{- $proxyPort = 80 -}} +{{- end -}} +{{- end -}} +proxyName: {{ $proxyName | quote }} +scheme: {{ $scheme | quote }} +proxyPort: {{ $proxyPort }} +{{- end -}} +{{- end -}} diff --git a/reg/helm/templates/configmap.yaml b/reg/helm/templates/configmap.yaml new file mode 100644 index 0000000..12f74ae --- /dev/null +++ b/reg/helm/templates/configmap.yaml @@ -0,0 +1,68 @@ +{{- if empty .Values.application.serviceEntries }} +{{- fail "Service entries must be provided in reg application values." }} +{{- end }} +{{- $connYaml := include "reg.tomcatConnector" . -}} +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ include "reg.fullname" . }}-config + labels: + {{- include "reg.labels" . | nindent 4 }} +data: + catalina.properties: |- +{{- if $connYaml }} +{{- $conn := $connYaml | fromYaml }} + tomcat.connector.scheme={{ $conn.scheme }} + tomcat.connector.proxyName={{ $conn.proxyName }} + tomcat.connector.proxyPort={{ $conn.proxyPort }} +{{- end }} + ca.nrc.cadc.util.Log4jInit.messageOnly=true + + reg.properties: | +{{- with .Values.application.authority }} + org.opencadc.reg.authority = {{ . }} +{{- end }} + + reg-resource-caps.properties: +{{ with .Values.application.serviceEntries }} +{{ range $index, $element := . }} + {{ $element.id }} = {{ $element.url }} +{{ end }} +{{ end }} + +{{ with .Values.application.applicationEntries }} + reg-applications.properties: + {{ range $index, $element := . }} + {{ $element.id }} = {{ $element.url }} + {{ end }} +{{ end }} + +{{- with .Values.application.logging }} + cadc-log.properties: +{{ with .userDistinguishedNames }} + {{- range $index, $element := . }} + user = {{ $element }} + {{- end }} +{{ end }} +{{ with .usernames }} + {{- range $index, $element := . }} + username = {{ $element }} + {{- end }} +{{ end }} +{{ with .groups }} + {{- range $index, $element := . }} + group = {{ $element }} + {{- end }} +{{ end }} +{{ end }} +{{ with .Values.application.vosi }} + cadc-vosi.properties: + {{- with .adminUserDistinguishedNames }} + {{- range $index, $element := . }} + user = {{ $element }} + {{- end }} + {{- end }} + {{- if .startupMode }} + startupMode = {{ .startupMode }} + {{- end }} +{{ end }} diff --git a/reg/helm/templates/deployment.yaml b/reg/helm/templates/deployment.yaml new file mode 100644 index 0000000..268883b --- /dev/null +++ b/reg/helm/templates/deployment.yaml @@ -0,0 +1,83 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "reg.fullname" . }} + labels: + {{- include "reg.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "reg.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "reg.labels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "reg.serviceAccountName" . }} + {{- with .Values.podSecurityContext }} + securityContext: + {{- toYaml . | nindent 8 }} + {{- end }} + containers: + - name: {{ .Chart.Name }} + {{- with .Values.securityContext }} + securityContext: + {{- toYaml . | nindent 12 }} + {{- end }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - name: http + containerPort: {{ .Values.service.port }} + protocol: TCP + {{- with .Values.livenessProbe }} + livenessProbe: + {{- toYaml . | nindent 12 }} + {{- end }} + {{- with .Values.readinessProbe }} + readinessProbe: + {{- toYaml . | nindent 12 }} + {{- end }} + {{- with .Values.resources }} + resources: + {{- toYaml . | nindent 12 }} + {{- end }} + volumeMounts: + - mountPath: "/config" + name: config-volume + {{- with .Values.volumeMounts }} + {{- toYaml . | nindent 12 }} + {{- end }} + volumes: + - name: config-volume + configMap: + name: {{ include "reg.fullname" . }}-config + {{- with .Values.volumes }} + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} diff --git a/reg/helm/templates/hpa.yaml b/reg/helm/templates/hpa.yaml new file mode 100644 index 0000000..a5af12a --- /dev/null +++ b/reg/helm/templates/hpa.yaml @@ -0,0 +1,32 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "reg.fullname" . }} + labels: + {{- include "reg.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "reg.fullname" . }} + minReplicas: {{ .Values.autoscaling.minReplicas }} + maxReplicas: {{ .Values.autoscaling.maxReplicas }} + metrics: + {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} +{{- end }} diff --git a/reg/helm/templates/httproute.yaml b/reg/helm/templates/httproute.yaml new file mode 100644 index 0000000..46418cd --- /dev/null +++ b/reg/helm/templates/httproute.yaml @@ -0,0 +1,38 @@ +{{- if .Values.httpRoute.enabled -}} +{{- $fullName := include "reg.fullname" . -}} +{{- $svcPort := .Values.service.port -}} +apiVersion: gateway.networking.k8s.io/v1 +kind: HTTPRoute +metadata: + name: {{ $fullName }} + labels: + {{- include "reg.labels" . | nindent 4 }} + {{- with .Values.httpRoute.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + parentRefs: + {{- with .Values.httpRoute.parentRefs }} + {{- toYaml . | nindent 4 }} + {{- end }} + {{- with .Values.httpRoute.hostnames }} + hostnames: + {{- toYaml . | nindent 4 }} + {{- end }} + rules: + {{- range .Values.httpRoute.rules }} + {{- with .matches }} + - matches: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .filters }} + filters: + {{- toYaml . | nindent 8 }} + {{- end }} + backendRefs: + - name: {{ $fullName }} + port: {{ $svcPort }} + weight: 1 + {{- end }} +{{- end }} diff --git a/reg/helm/templates/ingress.yaml b/reg/helm/templates/ingress.yaml new file mode 100644 index 0000000..7b1ce0c --- /dev/null +++ b/reg/helm/templates/ingress.yaml @@ -0,0 +1,43 @@ +{{- if .Values.ingress.enabled -}} +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: {{ include "reg.fullname" . }} + labels: + {{- include "reg.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- with .Values.ingress.className }} + ingressClassName: {{ . }} + {{- end }} + {{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} + {{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + {{- with .pathType }} + pathType: {{ . }} + {{- end }} + backend: + service: + name: {{ include "reg.fullname" $ }} + port: + number: {{ $.Values.service.port }} + {{- end }} + {{- end }} +{{- end }} diff --git a/reg/helm/templates/service.yaml b/reg/helm/templates/service.yaml new file mode 100644 index 0000000..c3bbcaf --- /dev/null +++ b/reg/helm/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "reg.fullname" . }} + labels: + {{- include "reg.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "reg.selectorLabels" . | nindent 4 }} diff --git a/reg/helm/templates/serviceaccount.yaml b/reg/helm/templates/serviceaccount.yaml new file mode 100644 index 0000000..2b1969b --- /dev/null +++ b/reg/helm/templates/serviceaccount.yaml @@ -0,0 +1,13 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "reg.serviceAccountName" . }} + labels: + {{- include "reg.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +automountServiceAccountToken: {{ .Values.serviceAccount.automount }} +{{- end }} diff --git a/reg/helm/templates/tests/test-connection.yaml b/reg/helm/templates/tests/test-connection.yaml new file mode 100644 index 0000000..cc95818 --- /dev/null +++ b/reg/helm/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "reg.fullname" . }}-test-connection" + labels: + {{- include "reg.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "reg.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/reg/helm/values.yaml b/reg/helm/values.yaml new file mode 100644 index 0000000..5bebf1a --- /dev/null +++ b/reg/helm/values.yaml @@ -0,0 +1,239 @@ +# Default values for reg. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +# This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ +replicaCount: 1 + +# This sets the container image more information can be found here: https://kubernetes.io/docs/concepts/containers/images/ +image: + repository: images.opencadc.org/core/reg + # This sets the pull policy for images. + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "1.2.1" + +# -- Begin application specific parameters. -- +application: + # Required VOSI-enabled API (web service) entries. Rendered into reg-resource-caps.properties. + # See: https://github.com/opencadc/reg/tree/main/reg#reg-resource-capsproperties-optional + # Example: + # - id: "ivo://cadc.nrc.ca/service/mycustomentry" + # url: "https://example.com/mylink/capabilities" + serviceEntries: [] + + # Optional web application (user interface) entries. Rendered into reg-applications.properties. + # See: https://github.com/opencadc/reg/tree/main/reg#reg-applicationsproperites-optional-experimental + # Example: + # - id: "ivo://cadc.nrc.ca/ui/mycustomentry" + # url: "https://example.com/mylink" + applicationEntries: [] + + # Optional IVOA authority for OAI publishing (reg.properties). + # When set, org.opencadc.reg.authority is written to the reg.properties ConfigMap entry. + # See: https://github.com/opencadc/reg/tree/main/reg#regproperties-optional + # Example: + # authority: "ivo://cadc.nrc.ca/reg" + authority: "" + + vosi: + # The distinguished names of users that are allowed to control VOSI functions, namely POSTing to /availability to make the application read-only. + # Example: + # adminUserDistinguishedNames: + # - "CN=Admin User,OU=CADC,O=CADC,C=CA" + # - "CN=Another Admin,OU=CADC,O=CADC,C=CA" + # adminUserDistinguishedNames: [] + + # optional mode at startup: Offline, ReadOnly, ReadWrite (default) + # Example: + # startupMode: ReadOnly + # startupMode: + + # Optionally configure log level administration for specific users or groups. + logging: + # List of distinguished names that should have enhanced logging. + # Example: + # - "CN=Audit User,OU=CADC,O=CADC,C=CA" + # - "CN=Another Audit,OU=CADC,O=CADC,C=CA" + # userDistinguishedNames: [] + + # List of usernames that should have enhanced logging. + # Example: + # - "audituser" + # - "anotheraudit" + # usernames: [] + + # List of group IVOA URIs that should have enhanced logging. + # Example: + # - "ivo://cadc.nrc.ca/gms/auditgroup" + # - "ivo://cadc.nrc.ca/gms/anotherauditgroup" + # groups: [] + +# -- End application specific parameters. -- + +# This is for the secrets for pulling an image from a private repository more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ +imagePullSecrets: [] +# This is to override the chart name. +nameOverride: "" +fullnameOverride: "" + +# This section builds out the service account more information can be found here: https://kubernetes.io/docs/concepts/security/service-accounts/ +serviceAccount: + # Specifies whether a service account should be created + create: true + # Automatically mount a ServiceAccount's API credentials? + automount: true + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "" + +# This is for setting Kubernetes Annotations to a Pod. +# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ +podAnnotations: {} +# This is for setting Kubernetes Labels to a Pod. +# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ +podLabels: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +# This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/ +service: + # This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + type: ClusterIP + # This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports + port: 8080 + +# This block is for setting up the ingress for more information can be found here: https://kubernetes.io/docs/concepts/services-networking/ingress/ +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: [] + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +# -- Expose the service via gateway-api HTTPRoute +# Requires Gateway API resources and suitable controller installed within the cluster +# (see: https://gateway-api.sigs.k8s.io/guides/) +httpRoute: + # HTTPRoute enabled. + enabled: false + # HTTPRoute annotations. + annotations: {} + # Which Gateways this Route is attached to. + parentRefs: + - name: gateway + sectionName: http + # namespace: default + # Hostnames matching HTTP header. + hostnames: + - chart-example.local + # List of rules and filters applied. + rules: + - matches: + - path: + type: PathPrefix + value: /headers + # filters: + # - type: RequestHeaderModifier + # requestHeaderModifier: + # set: + # - name: My-Overwrite-Header + # value: this-is-the-only-value + # remove: + # - User-Agent + # - matches: + # - path: + # type: PathPrefix + # value: /echo + # headers: + # - name: version + # value: v2 + +# -- Public URL for Tomcat behind a reverse proxy +# These values are written to catalina.properties as tomcat.connector.* and tell +# Tomcat the URL clients use to reach the service (equivalent to X-Forwarded-Proto, +# X-Forwarded-Host, and X-Forwarded-Port). They affect VOSI capabilities output: +# accessURL hostnames are rewritten to match the incoming request URL. +# +# Resolution order (per field): +# 1. Explicit value set here +# 2. Auto-derived from httpRoute (if enabled) or ingress (if enabled) +# 3. Omitted from catalina.properties if proxyName cannot be resolved +# +# Internal-only deployment (defaults): +# With ingress.enabled=false, httpRoute.enabled=false, service.type=ClusterIP, +# and these fields left empty, no tomcat.connector.* properties are emitted. +# The service remains ClusterIP-only (reachable by Pods in the cluster) and +# Tomcat uses the URL from each incoming request as-is. VOSI accessURLs will +# reflect the internal hostname callers use (e.g. -reg..svc.cluster.local). +# +# Override when the public URL differs from ingress/httpRoute hostnames, e.g. a CDN +# or external load balancer in front of the cluster ingress. +tomcat: + connector: + # Public URL scheme. Auto-derived as https (httpRoute or ingress with TLS) or http. + scheme: "" + # Public URL hostname. Auto-derived from httpRoute.hostnames[0] or ingress.hosts[0].host. + proxyName: "" + # Public URL port. Auto-derived as 443 (https) or 80 (http). + proxyPort: "" + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +# This is to setup the liveness and readiness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/ +livenessProbe: + +readinessProbe: + +# This section is for setting up autoscaling more information can be found here: https://kubernetes.io/docs/concepts/workloads/autoscaling/ +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +# Additional volumes on the output Deployment definition. +volumes: [] +# - name: foo +# secret: +# secretName: mysecret +# optional: false + +# Additional volumeMounts on the output Deployment definition. +volumeMounts: [] +# - name: foo +# mountPath: "/etc/foo" +# readOnly: true + +nodeSelector: {} + +tolerations: [] + +affinity: {}