From 96489e8218d6db344a1efa165a076f6bec8870cc Mon Sep 17 00:00:00 2001 From: Ulf Gebhardt Date: Mon, 24 Oct 2022 22:27:39 +0200 Subject: [PATCH 1/3] - fixed spelling errors - detailed upgrade guide for the certmanager --- TODO-next-update.md | 29 +++++++++++++++++++++++++---- deployment/kubernetes/Backup.md | 2 +- 2 files changed, 26 insertions(+), 5 deletions(-) diff --git a/TODO-next-update.md b/TODO-next-update.md index ff808fdb9..1c59a34f0 100644 --- a/TODO-next-update.md +++ b/TODO-next-update.md @@ -23,12 +23,33 @@ When you overtake this deploy and rebrand repo to your network you have to recog ### Deployment/Rebranding PR – chore: 🍰 Implement PRODUCTION_DB_CLEAN_ALLOW for Staging Production Environments #56 -- Copy `PRODUCTION_DB_CLEAN_ALLOW` from `deployment/kubernetes/values.template.yaml` to `values.yaml` and set it to `false` for production envireonments and only for several stage test servers to `true`. +- Copy `PRODUCTION_DB_CLEAN_ALLOW` from `deployment/kubernetes/values.template.yaml` to `values.yaml` and set it to `false` for production environments and only for several stage test servers to `true`. ### Deployment/Rebranding PR – chore: [WIP] 🍰 Refine docs, first step #46 -- Commit: `Update cert-manager apiVersion "cert-manager.io/v1alpha2" to "cert-manager.io/v1" - - Check for `kubectl` and `helm` versions. +Upgrade the cert-manager, but install CRDs of the version 1.0.0-alpha to actually be able to upgrade ocelot. Then uninstall the legacy CRDs and install the correct ones. + +``` +# upgrade cert-manager to 1.9.1 +> helm upgrade --set installCRDs=true --version 1.9.1 --namespace cert-manager cert-manager jetstack/cert-manager +# apply legacy CRDs +> kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.0.0-alpha.1/cert-manager.crds.yaml +# upgrade ocelot +> helm upgrade ocelot ./ +# delete legacy CRDs +> kubectl delete -f https://github.com/cert-manager/cert-manager/releases/download/v1.0.0-alpha.1/cert-manager.crds.yaml +# apply CRDs for cert-manager 1.9.1 +> kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.9.1/cert-manager.crds.yaml +``` + +Background: We had to upgrade cert-manager due to an external dependency - therefore we had to update cert-manager apiVersion `cert-manager.io/v1alpha2` to `cert-manager.io/v1`. + +The error occurring when not doing this is the following: +``` +Error: UPGRADE FAILED: unable to build kubernetes objects from current release manifest: [resource mapping not found for name: "letsencrypt-production" namespace: "" from "": no matches for kind "ClusterIssuer" in version "cert-manager.io/v1alpha2" +ensure CRDs are installed first, resource mapping not found for name: "letsencrypt-staging" namespace: "" from "": no matches for kind "ClusterIssuer" in version "cert-manager.io/v1alpha2" +ensure CRDs are installed first] +``` ## Version >= 1.0.8 with 'ocelotDockerVersionTag' 1.0.8-182 @@ -39,4 +60,4 @@ When you overtake this deploy and rebrand repo to your network you have to recog ## Version 1.0.7 with 'ocelotDockerVersionTag' 1.0.7-171 -- No informations. +- No information. diff --git a/deployment/kubernetes/Backup.md b/deployment/kubernetes/Backup.md index 738cdcfee..227b5765f 100644 --- a/deployment/kubernetes/Backup.md +++ b/deployment/kubernetes/Backup.md @@ -17,7 +17,7 @@ $ kubectl config use-context $ kubectl -n default get pods -o wide ``` -The very first step is to put the webside into **maintenance mode**. +The very first step is to put the website into **maintenance mode**. ### Set Maintenance Mode From de797e94f1e6f4e1dc509693e597719b1f92ca63 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Wolfgang=20Hu=C3=9F?= Date: Fri, 28 Oct 2022 17:25:11 +0200 Subject: [PATCH 2/3] Add all new configuration files and properties --- TODO-next-update.md | 32 +++++++++++++++++++++------- branding/constants/donation.js | 1 + branding/constants/headerMenu.js | 1 + branding/constants/links.js | 36 +++++++++++++++++++++++--------- branding/constants/logos.js | 4 ++++ 5 files changed, 56 insertions(+), 18 deletions(-) create mode 100644 branding/constants/donation.js diff --git a/TODO-next-update.md b/TODO-next-update.md index 1c59a34f0..cab2528fa 100644 --- a/TODO-next-update.md +++ b/TODO-next-update.md @@ -2,21 +2,36 @@ When you overtake this deploy and rebrand repo to your network you have to recognize the following changes and doings … -## This Latest Version >= 2.0.0 with 'ocelotDockerVersionTag' 2.0.0-250 +## Version >= 2.2.0 with 'ocelotDockerVersionTag' 2.2.0-267 + +### Main Code PR – feat: 🍰 Footer And Header Links Configurable To Have External Link Target #5590 + +- You have to add property `target` to all array elements with value `url` to your preferred value in `branding/constants/headerMenu.js` originally in main code file `webapp/constants/headerMenu.js`. +- You have to move value of all `externalLink` to new property `externalLink.url` and set new property `externalLink.target` to your preferred value in `branding/constants/links.js` originally in main code file `webapp/constants/links.js`. + +### Main Code PR – feat: 🍰 Make Donation Progress Bar Color Configurable #5593 + +- You have to set `PROGRESS_BAR_COLOR_TYPE` in `branding/constants/donation.js` originally in main code file `webapp/constants/donation.js` to your preferred value. + +### Main Code PR – feat: 🍰 Header Logo Routing Update #5579 + +- You have to move value of `LOGO_HEADER_CLICK.externalLink` to new property `LOGO_HEADER_CLICK.externalLink.url` and set new property `LOGO_HEADER_CLICK.externalLink.target` to your preferred value in `branding/constants/logos.js` originally in main code file `webapp/constants/logos.js`. + +## Version >= 2.0.0 with 'ocelotDockerVersionTag' 2.0.0-250 ### Main Code PR – feat: 🍰 Implement LOGO_HEADER_CLICK As Configuration #5525 -- You have to set `LOGO_HEADER_CLICK` in `branding/constants/logos.js` originally in main code file `webapp/constants/logos.js` to your prevered value. +- You have to set `LOGO_HEADER_CLICK` in `branding/constants/logos.js` originally in main code file `webapp/constants/logos.js` to your preferred value. ### Main Code Issue – 🌟 [EPIC] Release v2.0.0 – Beta Test → Final #5547 -- You have to set `SHOW_GROUP_BUTTON_IN_HEADER` in `branding/constants/groups.js` originally in main code file `webapp/constants/groups.js` to your prevered value. +- You have to set `SHOW_GROUP_BUTTON_IN_HEADER` in `branding/constants/groups.js` originally in main code file `webapp/constants/groups.js` to your preferred value. -## This Latest Version >= 1.1.0 with 'ocelotDockerVersionTag' 1.1.0-205 +## Version >= 1.1.0 with 'ocelotDockerVersionTag' 1.1.0-205 ### Deployment/Rebranding PR – chore: 🍰 Release v1.1.0 - Implement Categories Again #63 -- You have to add the `CATEGORIES_ACTIVE` from the `deployment/kubernetes/values.template.yaml` to your `deployment/kubernetes/values.yaml` and set it to your prevered value. +- You have to add the `CATEGORIES_ACTIVE` from the `deployment/kubernetes/values.template.yaml` to your `deployment/kubernetes/values.yaml` and set it to your preferred value. - Make sure the correct categories are in your Neo4j database on the server. ## Version >= 1.0.9 with 'ocelotDockerVersionTag' 1.0.9-199 @@ -29,7 +44,7 @@ When you overtake this deploy and rebrand repo to your network you have to recog Upgrade the cert-manager, but install CRDs of the version 1.0.0-alpha to actually be able to upgrade ocelot. Then uninstall the legacy CRDs and install the correct ones. -``` +```bash # upgrade cert-manager to 1.9.1 > helm upgrade --set installCRDs=true --version 1.9.1 --namespace cert-manager cert-manager jetstack/cert-manager # apply legacy CRDs @@ -45,7 +60,8 @@ Upgrade the cert-manager, but install CRDs of the version 1.0.0-alpha to actuall Background: We had to upgrade cert-manager due to an external dependency - therefore we had to update cert-manager apiVersion `cert-manager.io/v1alpha2` to `cert-manager.io/v1`. The error occurring when not doing this is the following: -``` + +```bash Error: UPGRADE FAILED: unable to build kubernetes objects from current release manifest: [resource mapping not found for name: "letsencrypt-production" namespace: "" from "": no matches for kind "ClusterIssuer" in version "cert-manager.io/v1alpha2" ensure CRDs are installed first, resource mapping not found for name: "letsencrypt-staging" namespace: "" from "": no matches for kind "ClusterIssuer" in version "cert-manager.io/v1alpha2" ensure CRDs are installed first] @@ -55,7 +71,7 @@ ensure CRDs are installed first] ### PR – feat: 🍰 Configure Cookie Expire Time #43 -- You have to add the `COOKIE_EXPIRE_TIME` from the `deployment/kubernetes/values.template.yaml` to your `deployment/kubernetes/values.yaml` and set it to your prevered value. +- You have to add the `COOKIE_EXPIRE_TIME` from the `deployment/kubernetes/values.template.yaml` to your `deployment/kubernetes/values.yaml` and set it to your preferred value. - Correct `locale` cookie exploration time in data privacy. ## Version 1.0.7 with 'ocelotDockerVersionTag' 1.0.7-171 diff --git a/branding/constants/donation.js b/branding/constants/donation.js new file mode 100644 index 000000000..3e36ae9a8 --- /dev/null +++ b/branding/constants/donation.js @@ -0,0 +1 @@ +export const PROGRESS_BAR_COLOR_TYPE = 'gradient' // 'uni' is the other option diff --git a/branding/constants/headerMenu.js b/branding/constants/headerMenu.js index 6d0a0afad..aa87a598c 100644 --- a/branding/constants/headerMenu.js +++ b/branding/constants/headerMenu.js @@ -7,6 +7,7 @@ export default { // { // nameIdent: 'nameIdent', // url: 'https://ocelot.social', + // target: '_blank', // }, ], } diff --git a/branding/constants/links.js b/branding/constants/links.js index 9cbc605c0..7efac159f 100644 --- a/branding/constants/links.js +++ b/branding/constants/links.js @@ -3,7 +3,11 @@ import { defaultPageParamsPages } from '~/components/utils/InternalPages.js' const ORGANIZATION = defaultPageParamsPages.ORGANIZATION.overwrite({ - externalLink: 'https://ocelot.social', // if string is defined and not empty it's dominating + // if defined it's dominating + externalLink: { + url: 'https://ocelot.social', + target: '_blank', + }, internalPage: { // footerIdent: 'site.made', // localized string identifier, if undefined default is used @@ -16,8 +20,12 @@ const ORGANIZATION = defaultPageParamsPages.ORGANIZATION.overwrite({ }, }) const DONATE = defaultPageParamsPages.DONATE.overwrite({ - // we use 'ocelot-social.herokuapp.com' at the moment, because redirections of 'ocelot.social' subpages are not working correctly - externalLink: 'https://ocelot-social.herokuapp.com/donations', // if string is defined and not empty it's dominating + // if defined it's dominating + externalLink: { + // we use 'ocelot-social.herokuapp.com' at the moment, because redirections of 'ocelot.social' subpages are not working correctly + url: 'https://ocelot-social.herokuapp.com/donations', + target: '_blank', + }, internalPage: { // footerIdent: 'site.donate', // localized string identifier, if undefined default is used @@ -30,8 +38,12 @@ const DONATE = defaultPageParamsPages.DONATE.overwrite({ }, }) const IMPRINT = defaultPageParamsPages.IMPRINT.overwrite({ - // we use 'ocelot-social.herokuapp.com' at the moment, because redirections of 'ocelot.social' subpages are not working correctly - externalLink: 'https://ocelot-social.herokuapp.com/imprint', // if string is defined and not empty it's dominating + // if defined it's dominating + externalLink: { + // we use 'ocelot-social.herokuapp.com' at the moment, because redirections of 'ocelot.social' subpages are not working correctly + url: 'https://ocelot-social.herokuapp.com/imprint', + target: '_blank', + }, internalPage: { // footerIdent: 'site.imprint', // localized string identifier, if undefined default is used @@ -44,7 +56,7 @@ const IMPRINT = defaultPageParamsPages.IMPRINT.overwrite({ }, }) const TERMS_AND_CONDITIONS = defaultPageParamsPages.TERMS_AND_CONDITIONS.overwrite({ - // externalLink: null, // if string is defined and not empty it's dominating + // externalLink: null, // if defined it's dominating internalPage: { // footerIdent: 'site.termsAndConditions', // localized string identifier, if undefined default is used @@ -57,7 +69,7 @@ const TERMS_AND_CONDITIONS = defaultPageParamsPages.TERMS_AND_CONDITIONS.overwri }, }) const CODE_OF_CONDUCT = defaultPageParamsPages.CODE_OF_CONDUCT.overwrite({ - // externalLink: null, // if string is defined and not empty it's dominating + // externalLink: null, // if defined it's dominating internalPage: { // footerIdent: 'site.code-of-conduct', // localized string identifier, if undefined default is used @@ -70,7 +82,7 @@ const CODE_OF_CONDUCT = defaultPageParamsPages.CODE_OF_CONDUCT.overwrite({ }, }) const DATA_PRIVACY = defaultPageParamsPages.DATA_PRIVACY.overwrite({ - // externalLink: null, // if string is defined and not empty it's dominating + // externalLink: null, // if defined it's dominating internalPage: { // footerIdent: 'site.data-privacy', // localized string identifier, if undefined default is used @@ -83,7 +95,7 @@ const DATA_PRIVACY = defaultPageParamsPages.DATA_PRIVACY.overwrite({ }, }) const FAQ = defaultPageParamsPages.FAQ.overwrite({ - // externalLink: null, // if string is defined and not empty it's dominating + // externalLink: null, // if defined it's dominating internalPage: { // footerIdent: 'site.faq', // localized string identifier, if undefined default is used @@ -96,7 +108,11 @@ const FAQ = defaultPageParamsPages.FAQ.overwrite({ }, }) const SUPPORT = defaultPageParamsPages.SUPPORT.overwrite({ - externalLink: 'https://ocelot.social', // if string is defined and not empty it's dominating + // if defined it's dominating + externalLink: { + url: 'https://ocelot.social', + target: '_blank', + }, internalPage: { // footerIdent: 'site.support', // localized string identifier, if undefined default is used diff --git a/branding/constants/logos.js b/branding/constants/logos.js index 136918762..714e78a2c 100644 --- a/branding/constants/logos.js +++ b/branding/constants/logos.js @@ -4,6 +4,10 @@ export default { LOGO_HEADER_PATH: '/img/custom/logo-horizontal.svg', LOGO_HEADER_WIDTH: '130px', LOGO_HEADER_CLICK: { + // externalLink: { + // url: 'https://ocelot.social', + // target: '_blank', + // }, externalLink: null, internalPath: { to: { From 9790e1516601b01fe43df8a4e8234d67d7db7d3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Wolfgang=20Hu=C3=9F?= Date: Fri, 28 Oct 2022 17:26:17 +0200 Subject: [PATCH 3/3] Release v2.2.0-267 --- package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index e760e3dd1..9625605f2 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ocelot-social-branded", - "version": "2.1.0", - "ocelotDockerVersionTag": "2.1.0-253", + "version": "2.2.0", + "ocelotDockerVersionTag": "2.2.0-267", "dockerOrganisation": "ocelotsocialnetwork", "description": "ocelot.social Branded", "author": "ocelot.social Community",