{"id":20838455,"url":"https://github.com/reload/os2display-k8s-environments","last_synced_at":"2026-04-20T08:31:29.772Z","repository":{"id":137511875,"uuid":"189592919","full_name":"reload/os2display-k8s-environments","owner":"reload","description":"Tracks os2display environments","archived":false,"fork":false,"pushed_at":"2019-08-16T09:26:47.000Z","size":7,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-12-25T19:54:50.442Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reload.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2019-05-31T12:48:44.000Z","updated_at":"2019-08-16T09:28:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"4b16565a-dae5-46ff-a559-416aa3c1b102","html_url":"https://github.com/reload/os2display-k8s-environments","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/reload/os2display-k8s-environments","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reload%2Fos2display-k8s-environments","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reload%2Fos2display-k8s-environments/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reload%2Fos2display-k8s-environments/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reload%2Fos2display-k8s-environments/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reload","download_url":"https://codeload.github.com/reload/os2display-k8s-environments/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reload%2Fos2display-k8s-environments/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32039925,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T00:18:06.643Z","status":"online","status_checked_at":"2026-04-20T02:00:06.527Z","response_time":94,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-18T01:10:19.803Z","updated_at":"2026-04-20T08:31:29.208Z","avatar_url":"https://github.com/reload.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OS2Display hosting-environments\nThis repository is used to manage one or more os2display environments.\nThe environments themselves are deployed via [Helm](https://helm.sh/), this repo and the tools within it simply makes it easier to handle the installation, upgrade and management of the releases.\n\nThe Helm chart itself is hosted at https://reload.github.io/os2display-k8s and the source can be found in the os2display-hosting repository.\n\nRequirements:\n* The Helm client\n* kubectl and a working connection to the cluster (see os2display-infrastructure for details on how to connect).\n\n## Initial repository configuration\nCreate a `\u003csome-prefix\u003e-master` branch, copy `_variables.source.example` to `_variables.source` and customize the settings in the file. Then commit the file to your repository, and use your branch for futur work.\n\n## Setting up Helm\nYou first need to add the chart repository to your local helm client.\n\n```bash\nhelm repo add os2display https://reload.github.io/os2display-k8s\n```\n\nYou can verify that you've accessed the repository by listing all charts in the repository.\n\n```bash\nhelm search os2display/\n```\n\nYou should see a single os2display chart.\n\nThen verify that you have access to the environment by executing\n\n```bash\nhelm list\n```\n\nThis should at the very least list the cert-manager and nginx-ingress used in os2display cluster. You may also see os2display-[environment] releases for each os2display environment handled via Helm.\n\nYou are now ready for creating and updating environments.\n\n## Installation of an environment\nUse these steps to setup a new os2display environment. Each environment is contained in a seperate Kubernetes namespace that will be created automatically.\n\n### Environment configuration\nFirst create the environment configuration using `./init.sh \u003cenvironment-name\u003e \u003cadmin-release-number\u003e`\n```bash\n# Create a staging environment using the reload-build-8 release\n./init staging 8\n```\n\nSee https://hub.docker.com/r/reload/os2display-admin-release/tags for at list of available release numbers, you probably want the latest.\n\nThis creates a directory named after the environment and instantiates a values.yaml and a secrets.yaml file. The latter should never be committed. \n\nInspect the yaml files and make any necessary updates to eg. the admin email or credentials. Note that you are not required to change anything. You rarely need the credentials listed in secrets.yaml, and they can always be extracted from the environment, but you may want to save copy for important environments such as production.\n\nYou could commit the values.yaml at this point, but you may just as well wait until you have a working environment.\n\n### Environment creation\nYou are now ready to create the environment, as all of the configuration is ready, this is a rather simple step. \n\nFirst make sure you have the latest helm chart\n```bash\nhelm repo update\n```\n\nThen invoke `./install.sh [environment]`\n\n```bash\n# Perform the initial installation of the staging environment\n./install staging\n```\n\nHelm will block until the environment has been created\n\n\n### Deleting an environment\nFirst have Helm delete the release using `helm delete os2display-[environment]`\n```bash\n# Delete the \"justtesting\" environment\nhelm delete os2display-justtesting\n```\n\nOr if you want to completely remove all traces so that you could create a new environment with the same name.\n```bash\n# Delete the \"justtesting\" environment completely.\nhelm delete --purge os2display-justtesting\n```\n\nThen remove the namespace using `kubectl delete namespace os2display-[environment]`\n```bash\nkubectl delete namespace os2display-justtesting\n```\n\n# Deploying a release\n\n## Build the images\nYou need to build and push the release images first. Go to the [building a release page](https://github.com/kkos2/os2display-infrastructure/documentation/building-a-release.md) and follow the steps there if you haven't already.\n\n## Make sure you are set up\nMake sure you are setup to use Helm and `kubectl`. You should follow the steps [here](https://github.com/kkos2/os2display-hosting-environments/blob/master/README.md)\n\n## Do the deployment\nTo deploy to an environment - for instance test, find the folder with the environment name and update the `tag` under `adminRelease` in `[env-dir]/values.yaml`.\n\nThen make sure you have the latest helm chart\n```bash\nhelm repo update\n```\n\nThen invoke `./upgrade.sh \u003cenvironment\u003e`\n```bash\n# Upgrade the test environment\n./upgrade.sh test\n```\nThat's it!\n\nCelebrate, then get back to work. \n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freload%2Fos2display-k8s-environments","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freload%2Fos2display-k8s-environments","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freload%2Fos2display-k8s-environments/lists"}