enforce best practices

[wkloucek]

Description

add best practice hints to the NOTES.txt

This is what I will see when I violate most of the best practices, eg. on my minikube dev deployment:

helmfile sync
Building dependency release=ocis, chart=../../charts/ocis
Upgrading release=ocis, chart=../../charts/ocis
Release "ocis" has been upgraded. Happy Helming!
NAME: ocis
LAST DEPLOYED: Thu Mar  9 09:00:37 2023
NAMESPACE: ocis
STATUS: deployed
REVISION: 52
TEST SUITE: None
NOTES:
You're now running
                 ,----..      ,---,   .--.--.
                /   /   \  ,`--.' |  /  /    '.
       ,---.   |   :     : |   :  : |  :  /`. /
      '   ,'\  .   |  ;. / :   |  ' ;  |  |--`
     /   /   | .   ; /--`  |   :  | |  :  ;_
    .   ; ,. : ;   | ;     '   '  ;  \  \    `.
    '   | |: : |   : |     |   |  |   `----.   \
    '   | .; : .   | '___  '   :  ;   __ \  \  |
    |   :    | '   ; : .'| |   |  '  /  /`--'  /
     \   \  /  '   | '/  : '   :  | '--'.     /
      `----'   |   :    /  ;   |.'    `--'---'
                \   \ .'   '---'
                 `---`


You can get the initial "admin" administrator user password by running:

kubectl -n <namespace> get secrets/admin-user --template='{{.data.password | base64decode}}'


#################################################################################
######   WARNING: Your deployment of oCIS does not follow all best          #####
######   practices for production deployments of oCIS.                      #####
######                                                                      #####
######   Following best practices are not applied:                          #####
######     - `features.externalUserManagement.enabled` should be            #####
######       set to `true`.                                                 #####
######     - `cache.type` should not be set to `noop`                       #####
######     - `features.basicAuthentication` should be set to `false`        #####
######     - `insecure.oidcIdpInsecure` should be set to `false`            #####
######     - `insecure.ocisHttpApiInsecure` should be set to `false`        #####
#################################################################################

#################################################################################
######   WARNING: Persistence is disabled for some services.                #####
######   You will lose your data when a service's pod is terminated.        #####
######                                                                      #####
######   Following services don't use persistence:                          #####
######     - storage-users                                                  #####
######     - storage-system                                                 #####
######     - idm                                                            #####
######     - store                                                          #####
######     - search                                                         #####
######     - nats                                                           #####
#################################################################################

Listing releases matching ^ocis$
ocis	ocis     	52      	2023-03-09 09:00:37.301174228 +0100 CET	deployed	ocis-0.1.0	3.0.0-alpha.1


UPDATED RELEASES:
NAME   CHART               VERSION
ocis   ../../charts/ocis     0.1.0

Related Issue

• Fixes parts of Issue warning if best practices are not followed for current configuration #112

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Technical debt
• Tests only (no source changes)

Checklist:

• Code changes
• Unit tests added
• Acceptance tests added
• Documentation generated (make docs) and committed
• Documentation ticket raised:
• Documentation PR created:

[d7oc]

See inline comment.