Updates on files

Added changeset on workflow

Author: Alexander Rogalskiy

.github/workflows/helm.yml

@@ -13,7 +13,7 @@ jobs:
         id: prep
         run: |
           VERSION=$(grep 'version' package.json | awk '{ print $4 }' | tr -d '"')
-          CHANGELOG="https://github.com/AlexRogalskiy/java-patterns/blob/main/CHANGELOG.md#$(echo $VERSION | tr -d '.')"
+          CHANGELOG="https://github.com/AlexRogalskiy/android-patterns/blob/main/CHANGELOG.md#$(echo $VERSION | tr -d '.')"
           echo ::set-output name=BUILD_DATE::$(date -u +'%Y-%m-%dT%H:%M:%SZ')
           echo ::set-output name=VERSION::${VERSION}
           echo ::set-output name=CHANGELOG::${CHANGELOG}
@@ -43,7 +43,7 @@ jobs:
           build-args: |
             REVISON=${{ github.sha }}
           tags: |
-            ghcr.io/AlexRogalskiy/java-patterns:${{ steps.prep.outputs.VERSION }}
+            ghcr.io/AlexRogalskiy/android-patterns:${{ steps.prep.outputs.VERSION }}
           labels: |
             org.opencontainers.image.title=${{ github.event.repository.name }}
             org.opencontainers.image.description=${{ github.event.repository.description }}
@@ -54,7 +54,7 @@ jobs:
             org.opencontainers.image.created=${{ steps.prep.outputs.BUILD_DATE }}
       - name: Check images
         run: |
-          docker buildx imagetools inspect ghcr.io/AlexRogalskiy/java-patterns:${{ steps.prep.outputs.VERSION }}
+          docker buildx imagetools inspect ghcr.io/AlexRogalskiy/android-patterns:${{ steps.prep.outputs.VERSION }}
       - name: Publish Helm charts
         uses: stefanprodan/[email protected]
         with:

.markdownlintignore

@@ -1 +1,2 @@
 node_modules
+tilt_modules

.prettierignore

@@ -14,3 +14,7 @@ coverage
 dist
 helm
 tilt_modules
+okteto
+charts
+k8s
+release

.stignore

@@ -0,0 +1,3 @@
+/.git
+/node_modules
+/tilt_modules

.yaml-lint.yml

@@ -4,13 +4,17 @@
 
 extends: default
 
+locale: en_US.UTF-8
+
 rules:
   # 150 chars should be enough, but don't fail if a line is longer
   line-length:
     max: 150
+    allow-non-breakable-inline-mappings: true
     level: warning
   comments:
     min-spaces-from-content: 1
+    level: warning
   braces:
     min-spaces-inside: 0
     max-spaces-inside: 0
@@ -19,6 +23,24 @@ rules:
     max-spaces-inside: 0
   indentation:
     indent-sequences: consistent
-  document-start: disable
+    level: warning
+  document-end: disable
+  document-start:
+    level: warning
   indentation: disable
-  truthy: false
+  colons: enable
+  commas: enable
+  comments-indentation:
+    level: warning
+  empty-lines: enable
+  empty-values: disable
+  hyphens: enable
+  key-duplicates: enable
+  key-ordering: disable
+  new-line-at-end-of-file: enable
+  new-lines: enable
+  octal-values: disable
+  quoted-strings: disable
+  trailing-spaces: enable
+  truthy:
+    level: warning

Makefile

@@ -15,6 +15,8 @@ else
 endif
 
 IMAGE ?= styled-android-patterns
+OKTETO_IMAGE ?= okteto/styled-android-patterns
+DOCKER_IMAGE ?= alexanderr/styled-android-patterns
 TAG ?= latest
 
 # UNAME_OS stores the value of uname -s.
@@ -107,12 +109,12 @@ helm-lint:
 # Run helm start command.
 .PHONY: helm-start
 helm-start:
-	helm upgrade --install backend-java-patterns -f charts/values.yaml --create-namespace --namespace webapp charts
+	helm upgrade --install backend-android-patterns -f charts/values.yaml --create-namespace --namespace webapp charts
 
 # Run helm stop command.
 .PHONY: helm-stop
 helm-stop:
-	helm uninstall backend-java-patterns --namespace webapp
+	helm uninstall backend-android-patterns --namespace webapp
 
 # Run helm package command.
 .PHONY: helm-package
@@ -123,3 +125,25 @@ helm-package:
 # Run helm dev command.
 .PHONY: helm-dev
 helm-dev: clean helm-lint helm-package
+
+# Run okteto build command.
+.PHONY: okteto
+okteto:
+	okteto build -t $(DOCKER_IMAGE) .
+	okteto build -t $(OKTETO_IMAGE) .
+
+# Run local build command.
+.PHONY: local-build
+local-build:
+	python3 -m pip install -r ./docs/requirements.txt
+	python3 -m mkdocs build --clean --config-file mkdocs.yml
+
+# Run local run command.
+.PHONY: local-run
+local-run:
+	python3 -m mkdocs serve --verbose --dirtyreload
+
+# Run github pages deploy command.
+.PHONY: gh-pages
+gh-pages:
+	python3 -m mkdocs --verbose gh-deploy --force --remote-branch gh-pages

README.md

@@ -169,6 +169,7 @@ python -m pip install markdown-include
 4\) Start the server at ***localhost*** by running the following command:
 
 ```shell script
+python -m mkdocs build --clean --config-file mkdocs.yml
 python -m mkdocs serve --verbose --dirtyreload
 ```
 

charts/templates/deployment.yaml

@@ -5,6 +5,9 @@ metadata:
   name: {{ $fullName }}
   labels:
     {{- include "backend-android-patterns.labels" . | nindent 4 }}
+  {{- with .Values.deployment.additionalLabels }}
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
 spec:
   {{- if not .Values.hpa.enabled }}
   replicas: {{ .Values.general.replicaCount }}

charts/templates/secret.yaml

@@ -5,6 +5,14 @@ metadata:
   name: {{ include "backend-android-patterns.fullname" . }}
   labels:
     {{- include "backend-android-patterns.labels" . | nindent 4 }}
+  {{- with .Values.secrets.additionalLabels }}
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
 data:
   BASE_URL: {{ default "" .Values.secrets.data.baseUrl | b64enc | quote }}
+  {{- if .Values.secrets.data.baseToken }}
+  BASE_TOKEN:  {{ .Values.secrets.data.baseToken | b64enc | quote }}
+  {{- else }}
+  BASE_TOKEN: {{ randAlphaNum 10 | b64enc | quote }}
+  {{- end }}
 {{- end }}

charts/values.yaml

@@ -31,6 +31,11 @@ configMaps:
 
 secrets:
   create: false
+  additionalLabels:
+    app.kubernetes.io/component: vault
+  data:
+    baseUrl: ""
+    baseToken: ""
 
 ui:
   color: "#34577c"

docs/requirements.txt

@@ -7,6 +7,7 @@ markdown-checklist>=0.4.1
 fontawesome-markdown>=0.2.6
 markdown-include>=0.6.0
 pymdown-extensions>=8.2
+python-markdown-math>=0.6
 mkdocs-material-extensions>=1.0
 mkdocs-git-revision-date-localized-plugin>=0.9.2
 mkdocs-awesome-pages-plugin>=2.5.0

k8s/backend/deployment.yaml

@@ -122,7 +122,6 @@ spec:
               memory: "3G"
               ephemeral-storage: "3G"
           securityContext:
-            allowPrivilegeEscalation: false
             allowPrivilegeEscalation: false
             privileged: false
             readOnlyRootFilesystem: false

mkdocs.yml

@@ -106,15 +106,20 @@ markdown_extensions:
   - pymdownx.mark: {}
   - pymdownx.critic: {}
   - pymdownx.inlinehilite: {} # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#inlinehilite
-  - pymdownx.superfences: {} # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#superfences
+  - pymdownx.superfences: # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#superfences
+     custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_div_format
   - pymdownx.tabbed: {} # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#tabbed
   - pymdownx.details: {} # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#details
   - pymdownx.emoji: # https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#configuration
-      emoji_index: "!!python/name:materialx.emoji.twemoji"
-      emoji_generator: "!!python/name:materialx.emoji.to_svg"
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
   - smarty: {} # https://python-markdown.github.io/extensions/smarty/
   - nl2br: {} # https://python-markdown.github.io/extensions/smarty/
   - mdx_truly_sane_lists: {} # https://github.com/radude/mdx_truly_sane_lists -> proper indentation of md list items
+  - markdown.extensions.attr_list: {}
 
 # Other Settings
 strict: false # halt processing when a warning is raised

okteto-pipeline.yml

@@ -0,0 +1,10 @@
+icon: https://okteto.com/icons/icon-384x384.png
+deploy:
+  - okteto build -t okteto.dev/styled-android-patterns .
+#   - kubectl create clusterrolebinding kube-system-cluster-admin --clusterrole=cluster-admin --serviceaccount=kube-system:default
+#   - kubectl create role access-secrets --verb=get,list,watch,update,create --resource=secrets
+#   - kubectl create rolebinding --role=access-secrets default-to-secrets --serviceaccount=kube-system:default
+#   - helm upgrade --install backend-android-patterns -f charts/values.yaml --create-namespace --namespace webapp charts --set tag=${OKTETO_GIT_COMMIT}
+  - kubectl apply -f okteto/deployment.yaml
+devs:
+  - okteto.yml

okteto.yml

@@ -0,0 +1,33 @@
+name: backend-android-patterns-v1
+image: okteto/styled-android-patterns
+labels:
+  app.kubernetes.io/part-of: devops
+  app.kubernetes.io/component: documentation
+environment:
+  - ENVIRONMENT=Development
+# command: [ "/usr/bin/python3.8", "-m", "mkdocs", "serve", "--verbose", "--dirtyreload", "--dev-addr=0.0.0.0:8000" ]
+sync:
+  - .:/docs
+workdir: .
+remote: 2222
+resources:
+  requests:
+    memory: "64Mi"
+    cpu: "250m"
+  limits:
+    memory: "128Mi"
+    cpu: "500m"
+forward:
+  - 8000:8000
+persistentVolume:
+  enabled: false
+lifecycle:
+  postStart: false
+  postStop: true
+securityContext:
+  runAsUser: 1000
+  runAsGroup: 2000
+  fsGroup: 3000
+  capabilities:
+    add:
+    - SYS_PTRACE