[{"_1":2,"_194":-5,"_195":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_169":170},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":89,"_110":111,"_157":-5,"_158":11,"_159":21,"_160":11,"_161":11,"_162":-5,"_163":11,"_164":-5,"_165":166,"_167":112,"_168":-7},"canonicalUrl","https://hub.docker.com/r/containersol/timber/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","containersol","reponame","timber","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2019-01-25T13:13:10.00793Z","description","","is_private","last_updated","2020-07-14T18:32:10.876477Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",604,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Timber - the Training companion app\n\nHey there! This is Timber.\n\nTimber is a companion app for the [ContainerSolutions trainings](https://training.container-solutions.com/?utm_source=timber_docs).\n\nIts aim is to provide with engineers attending the trainings with a sample\napplication they can build upon and play with during the trainings.\n\nIt replicates a \"traditional web app\" setup where there is a frontend, a backend and a database (we'll use Redis).\n\nFunctionality is enabled & disabled mostly through environment variables.\n\nTimber is written in Python 3. Fear not! It is, we hope, well-documented and fairly easy to understand.\n\n- [Timber - the Training companion app](#timber---the-training-companion-app)\n - [💻 Running it locally](#%F0%9F%92%BB-running-it-locally)\n - [🚀 Running it on Kubernetes](#%F0%9F%9A%80-running-it-on-kubernetes)\n - [🐉 Backend](#%F0%9F%90%89-backend)\n - [`/api/v1/fortune`](#apiv1fortune)\n - [`/api/v1/metadata`](#apiv1metadata)\n - [`/api/v1/configuration`](#apiv1configuration)\n - [`/api/v1/colors`](#apiv1colors)\n - [`/api/v1/redis_detection`](#apiv1redisdetection)\n - [`/api/v1/state`](#apiv1state)\n - [💎 Frontend](#%F0%9F%92%8E-frontend)\n - [`/`](#)\n - [`configuration.py`](#configurationpy)\n - [`backend.py`](#backendpy)\n\n## 💻 Running it locally\n\nPretty straightforward! - `$ docker-compose up`\n\nEditing any `.py` files will make the application reload with your changes.\n\n## 🚀 Running it on Kubernetes\n\nSome manifests are provided for you in the [`manifests/`](manifests/) folder.\n\nThere are different ways to set this up, namely, you could at least:\n\n- Run the backend alone\n- Run the backend and the frontend in the same pod\n- Run the backend and the frontend in different pods, accessing each other with services\n- Run the frontend, backend and redis in different pods, accessing each other with services\n- Run the frontend, backend and redis in the same pod\n\nAnd many more!\n\n## 🐉 Backend\n\nThe backend is an API exposing data through HTTP endpoints.\n\nThey are all GET endpoints for simplicity.\n\nSome endpoints have a `description` value to pass a human readable sentence to the frontend.\n\nThe entrypoint of the API is [`app.py`](backend/app.py).\n\n### [`/api/v1/fortune`](backend/app.py)\n\nReturns a fortune cookie read from a file on a volume. This file is generated by a separate container. See `manifests/backend/solutions/deploy-volume.yml`\n\n### [`/api/v1/metadata`](backend/metadata.py)\n\nThe metadata is gathered mostly through the [Kubernetes downward API](https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/).\n\nThese environment variables are read, defaulting to `unknown` if empty:\n\n- `MY_POD_NAME`\n- `MY_POD_IP`\n- `MY_POD_NAMESPACE`\n- `MY_NODE_NAME`\n\nThis API returns this data in JSON:\n```\n{\n description: <...>,\n hostname: <...>, # container hostname\n ip: <...>, # IP from the downward API\n namespace: <...>, # namespace from the downward API\n node: <...>, # node from the downward API\n pod: <...> # pod from the downward API\n}\n```\n\n### [`/api/v1/configuration`](backend/configuration.py)\n\nThis API endpoint returns the configuration of Timber.\n\nThis is set through environment variables.\n\n| Environment Variable | What it does | Default |\n|--------------------------------|-------------------|---------|\n| `TIMBER_LIVENESS_PROBE_ENABLED` | Set to any value to enable `/probe/liveness` | Disabled |\n| `TIMBER_READINESS_PROBE_ENABLED` | Set to any value to enable `/probe/readiness` | Disabled |\n| `TIMBER_VERSION` | Currently running application version | v1.0 |\n| `TIMBER_REDIS_HOST` | Redis server used if state is set to `redis` | `redis` |\n| `TIMBER_STATE` | State storage: `inmemory`, `redis` | `inmemory` |\n| `TIMBER_LISTEN_PORT` | Set the port Timber listens on | 8080 |\n\n\n```\n{\n description: <...>,\n liveness_probe_enabled: ,\n readiness_probe_enabled: ,\n redis_host: <...>,\n state: <...>,\n version: <...>\n}\n```\n\n### [`/api/v1/colors`](backend/colors.py)\n\nThis API endpoint returns deterministic hex colors.\n\nColors are generated based on the values of `TIMBER_VERSION`, `TIMBER_HOSTNAME`, `TIMBER_STATE`.\n\n```\n{\n hostname: <...>,\n state: <...>,\n version: <...>\n}\n```\n\n### [`/api/v1/redis_detection`](backend/redis_detection.py)\n\nThis API endpoint tells you whether Redis is detected in the same pod.\n\nIt works by trying to connect to Redis on `localhost`, and since pods share networking, this would work if Redis is running alongside the backend.\n\n```\n{\n description: <...>,\n is_detected: \n}\n```\n\n### [`/api/v1/state`](backend/state.py)\n\nThis API returns informations about the state kept by the backend.\n\n```\n{\n type: ,\n image_link: <...> # The picture we are keeping in state\n state_hits: # Number of times the state has been checked\n}\n```\n\n## 💎 Frontend\n\nThe frontend shows all the data that the backend provides, and some more.\n\nData from all the backend APIs is used, as well as showing the frontend hostname.\n\n### [`/`](frontend/app.py)\n\nThis is the frontend index. It uses [index.html](frontend/index.html) as a template,\nand gets the data from the backend API.\n\n### [`configuration.py`](frontend/configuration.py)\n\nFrontend configuration, through environment variables\n\n| Environment Variable | What it does | Default |\n|--------------------------------|---------------------|----------------------|\n| `TIMBER_BACKEND_API_URL` | Set the backend URL | `http://backend:8080`\n| `TIMBER_LISTEN_PORT` | Set the port Timber listens on | 8080 |\n\n### [`backend.py`](frontend/backend.py)\n\nThis file contains a `get_api()` helper function to get data as dictionary from the backend API endpoints.\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",151232820,"orgData",{"_90":91,"_92":93,"_94":95,"_96":33,"_97":48,"_98":99,"_100":101,"_102":103,"_104":105,"_106":48,"_107":48,"_108":48,"_109":21},"id","38d9744474c111e4bea40242ac11001b","uuid","38d97444-74c1-11e4-bea4-0242ac11001b","type","organization","orgname","full_name","location","Amsterdam","company","Container Solutions","profile_url","http://container-solutions.com/","date_joined","2014-11-14T13:53:08.105798Z","gravatar_url","gravatar_email","badge","is_active","recentTags",[112,148],{"_113":44,"_114":115,"_116":117,"_90":118,"_119":120,"_50":137,"_138":115,"_139":33,"_140":56,"_57":141,"_142":143,"_144":128,"_145":137,"_146":66,"_147":21},"content_type","creator",145492,"full_size",33350280,45144906,"images",[121],{"_122":123,"_124":125,"_126":48,"_127":128,"_129":130,"_131":132,"_133":48,"_134":-5,"_135":117,"_63":66,"_136":-5},"architecture","amd64","digest","sha256:b9a7ff404a75186d495a1e937cca16bb06d4e7dc3689fe9cac62e33521bc28ea","features","last_pulled","2026-10-04T18:46:21.054099011Z","last_pushed","2020-07-14T13:35:01Z","os","linux","os_features","os_version","size","variant","2020-07-14T18:32:10.540752Z","last_updater","last_updater_username","media_type","frontend","repository",6600138,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_113":44,"_114":115,"_116":149,"_90":150,"_119":151,"_50":155,"_138":115,"_139":33,"_140":56,"_57":156,"_142":143,"_144":154,"_145":155,"_146":66,"_147":21},34037604,45144735,[152],{"_122":123,"_124":153,"_126":48,"_127":154,"_129":130,"_131":132,"_133":48,"_134":-5,"_135":149,"_63":66,"_136":-5},"sha256:d701e84c3fbbd8dd80b5b928a81c5c1ab049fccbbc6e0650680d9f9f407b2591","2026-10-16T04:22:27.910568856Z","2020-07-14T18:32:06.557242Z","backend","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxRunInCloud","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":171,"_178":179,"_165":192,"_193":11},{"_40":172,"_42":173,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":174,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":175,"_79":11,"_80":177,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":176},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_180":181,"_182":-5,"_183":-5,"_184":185},"count",2,"next","previous","results",[186,189],{"_113":44,"_114":115,"_116":117,"_90":118,"_119":187,"_50":137,"_138":115,"_139":33,"_140":56,"_57":141,"_142":143,"_144":128,"_145":137,"_146":66,"_147":21},[188],{"_122":123,"_124":125,"_126":48,"_127":128,"_129":130,"_131":132,"_133":48,"_134":-5,"_135":117,"_63":66,"_136":-5},{"_113":44,"_114":115,"_116":149,"_90":150,"_119":190,"_50":155,"_138":115,"_139":33,"_140":56,"_57":156,"_142":143,"_144":154,"_145":155,"_146":66,"_147":21},[191],{"_122":123,"_124":153,"_126":48,"_127":154,"_129":130,"_131":132,"_133":48,"_134":-5,"_135":149,"_63":66,"_136":-5},[],"canDeleteTags","actionData","errors"]

containersol/timber

Tags for containersol/timber