{"id":25353917,"url":"https://github.com/aborroy/alf-k8s","last_synced_at":"2025-10-29T22:30:56.386Z","repository":{"id":227305245,"uuid":"771049281","full_name":"aborroy/alf-k8s","owner":"aborroy","description":"Alfresco Community Kubernetes Deployment CLI using Helm and Docker Desktop","archived":false,"fork":false,"pushed_at":"2025-02-13T13:56:20.000Z","size":53,"stargazers_count":3,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-13T14:39:01.552Z","etag":null,"topics":["alfresco","cli","kubernetes-deployment"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aborroy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-12T15:45:53.000Z","updated_at":"2025-02-13T13:55:33.000Z","dependencies_parsed_at":"2024-03-12T17:02:09.095Z","dependency_job_id":"334fda9c-801a-481f-bc83-2555b42ad2ff","html_url":"https://github.com/aborroy/alf-k8s","commit_stats":null,"previous_names":["aborroy/alf-k8s"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aborroy%2Falf-k8s","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aborroy%2Falf-k8s/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aborroy%2Falf-k8s/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aborroy%2Falf-k8s/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aborroy","download_url":"https://codeload.github.com/aborroy/alf-k8s/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238902582,"owners_count":19549776,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alfresco","cli","kubernetes-deployment"],"created_at":"2025-02-14T19:56:04.930Z","updated_at":"2025-10-29T22:30:51.059Z","avatar_url":"https://github.com/aborroy.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# alf-k8s\n\nAlfresco Community Kubernetes Deployment CLI using [Helm](https://helm.sh) and [Docker Desktop](https://docs.docker.com/desktop/) or [Kubernetes In Docker](https://kind.sigs.k8s.io/) (KinD) cluster.\n\nAdditional details are available in [ACS Deployment](https://github.com/Alfresco/acs-deployment/blob/master/docs/helm/desktop-deployment.md).\n\nRequires separate install of [kubectl](https://kubernetes.io/docs/reference/kubectl/) and [Helm](https://helm.sh).\n\n## Enabling Kubernetes in Docker Desktop\n\nApply following configurations to Docker Desktop settings:\n\n- `Settings \u003e Resources \u003e Advanced \u003e Memory: 16 GB`\n- `Settings \u003e Kubernetes \u003e Enable Kubernetes: ON`\n\nAfter changing the necessary settings `Apply and restart` the docker desktop.\n\n## Setting up kind\n\nTake a look to the [KinD quickstart](https://kind.sigs.k8s.io/docs/user/quick-start/) to learn how to install the binary cli on your machine and to learn briefly the main commands that you can run.\n\nApply following configurations to Docker Desktop settings:\n\n- `Settings \u003e Resources \u003e Advanced \u003e Memory: 16 GB`\n- `Settings \u003e Kubernetes \u003e Enable Kubernetes: OFF`\n\nAfter changing the necessary settings `Apply and restart` the docker desktop.\n\n## Usage\n\nDownload the binary compiled for your architecture (Linux, Windows or Mac OS) from [**Releases**](https://github.com/aborroy/alf-k8s/releases).\n\n\u003e\u003e You may rename the binary to `alf-k8s`, all the following samples are using this command name by default.\n\nUsing `-h` flag provides detail on the use of the different commands available.\n\n**Create**\n\n`Create` command produces required assets to deploy Alfresco Community in Kubernetes.\n\n```bash\n$ ./alf-k8s create -h\nCreate assets to deploy Alfresco in Kubernetes\n\nUsage:\n  alf-k8s create [flags]\n\nFlags:\n      --docker-user string       Username for Docker Hub\n      --docker-password string   Password for username in Docker Hub\n  -h, --help                     help for create\n  -i, --interactive              Input values replying to command line prompts instead of using command line parameters\n  -k, --kubernetes string        Kubernetes cluster: docker-desktop (default) or kind\n  -o, --output string            Local Directory to write produced assets, 'output' by default\n  -p, --password string          Password for Alfresco admin user\n  -t, --tls                      Enable TLS protocol for ingress\n  -v, --version string           Version of ACS to be deployed (23.1 or 23.2)\n```\n\n\u003e\u003e Using `docker-user` and `docker-password` is recommended to avoid quota restrictions from Docker Hub when using `kind` as Kubernetes cluster\n\n### Creating a sample deployment\n\n**Using command line parameters**\n\nRun the command selecting the Alfresco Community version to be deployed . Additional options can be set using any parameter value from *flags* list.\n\n```bash\n$ ./alf-k8s create -v 23.2\n```\n\n\u003e\u003e The previous command uses Docker Desktop as Kubernetes cluster, add `-k kind` to use [kind](https://kind.sigs.k8s.io) instead.\n\n**Replying to prompts**\n\nRun the command using interactive mode.\n\n```bash\n$ ./alf-k8s create -i\n? Which ACS version do you want to use? 23.2\n? What Kubernetes cluster do you want to use? docker-desktop\n? Do you want to use HTTPs for Ingress? No\n? Choose the password for your admin user admin\n```\n\n\u003e\u003e Even when using interactive mode, output directory can be specified using the `-o` flag.\n\n**Output folder**\n\nKubernetes assets will be produced by default in `output` folder:\n\n```bash\n$ tree output\noutput\n├── common.sh\n├── custom\n│   ├── Chart.yaml\n│   └── templates\n│       └── configmap-repo.yaml\n├── start.sh\n├── stop.sh\n└── values\n    ├── community_values.yaml\n    ├── resources_values.yaml\n    └── version_values.yaml\n```\n\nAlfresco can be deployed to Kubernetes (only in Mac OS or Linux) using provided shell script:\n\n```bash\n$ cd output\n$ ./start.sh\n...\nYou can access all components of Alfresco Content Services using the same root address, but different paths as follows:\n\n  Content: http://localhost/alfresco\n  Share: http://localhost/share\n  API-Explorer: http://localhost/api-explorer\n  Alfresco Digital Workspace: http://localhost/workspace/\n```\n\nOnce the deployment has been tested, resources can be released using the following shell script:\n\n```bash\n$ ./stop.sh\nrelease \"acs\" uninstalled\nnamespace \"alfresco\" deleted\nrelease \"ingress-nginx\" uninstalled\nnamespace \"ingress-nginx\" deleted\n```\n\n## Troubleshooting\n\n### Lens\n\nThe easiest way to troubleshoot issues on a Kubernetes deployment is to use the [Lens](https://k8slens.dev) desktop application, which is available for Mac, Windows and Linux. Follow the [getting started guide](https://docs.k8slens.dev/v4.0.3/getting-started) to configure your environment.\n\n### Kubernetes Dashboard\n\nAlternatively, the traditional Kubernetes dashboard can also be used. Presuming you have deployed the dashboard in the cluster you can use the following steps to explore your deployment:\n\n1. Retrieve the service account token with the following command:\n\n    ```bash\n    kubectl -n kube-system describe secret $(kubectl -n kube-system get secret | grep eks-admin | awk '{print $1}')\n    ```\n\n2. Run the kubectl proxy:\n\n    ```bash\n    kubectl proxy \u0026\n    ```\n\n3. Open a browser and navigate to: `http://localhost:8001/api/v1/namespaces/kubernetes-dashboard/services/https:kubernetes-dashboard:/proxy/#/login`\n\n4. Select \"Token\", enter the token retrieved in step 1 and press the \"Sign in\" button\n\n5. Select \"alfresco\" from the \"Namespace\" drop-down menu, click the \"Pods\" link and click on a pod name\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faborroy%2Falf-k8s","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faborroy%2Falf-k8s","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faborroy%2Falf-k8s/lists"}