[{"_1":2,"_176":-5,"_177":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_155":156},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":85,"_108":109,"_146":-5,"_147":11,"_148":17,"_149":11,"_150":-5,"_151":11,"_152":-5,"_153":154},"canonicalUrl","https://hub.docker.com/r/leandelivery/filesubst/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","leandelivery","reponame","filesubst","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2020-04-03T12:38:44.693776Z","description","substitutes placeholders in files by environment variables values","is_private","last_updated","2020-04-29T09:59:18.815869Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",87608,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Introduction to SEV\nHow many times have you been facing a situation when you have some dockerized application which stores its configuration on the filesystem?\n\nWhat's a problem you may ask. \nIn a usual Docker world we would prefer to override or even initialize configuration parameters over environment variables.\n\nWhy is that ? \nBy design all Docker containers are stateless. \n\nThat means, by default, working with stateful techniques in Docker (filesystem is one of those) increases complexity and operational costs.\n\n\n# Real-life example\n## Introductory\nLet's assume we have a single-page-application (ReactJS). That application consists of some usual `static content`:\n* HTML\n* CSS\n* JavaScript\n* Assets (images, icons, etc.)\n\nWe have `3` environments:\n* development\n* qa\n* production\n\nAnd using `Adobe Analytics` and `Google Analytics` for collecting data of user activities.\n\n\n**Important Note**\nWe must segregate user activities data between environments, meaning each environment has its unique `Adobe Analytics URL` and `Google Analytics URL` defined in `index.html` file.\n```html=\n...\n\n\n...\n```\n\n## Dockerizing\nFor usual web applications we normally use `nginx` Docker image and populate it with `static content`.\n```Dockerfile=\nFROM nginx:alpine\n\n# copy nginx configuration\nCOPY nginx/default.conf /etc/nginx/conf.d/\n\n# copy static content\nCOPY dist/ /html\n\n# run nginx\nCMD [\"/bin/sh\", \"-c\", \"nginx -g 'daemon off;'\"]\n```\n\n## Problem statement\nHow would you deploy that `Docker image` and adjust `Adobe Analytics URL` and `Google Analytics URL` according to the specifc `environment` ?\n\n**Option 1**\nCompile `static content` per `environment`.\n\\- very time consuming and inefficient\n\n**Option 2**\nSet `environment variables` and utilize `bash`.\n\\- tricky, complex and messy\n\n**Option 3**\nMany `other options` are available, but with `operational and complexity overheads`. \n\n# Solution\nThis is where the `sev` comes handy.\n\n## Introduction\n`sev` is a CLI utility written in Golang.\n\n## Usage example\n### Let's change our `index.html`:\n```html=\n...\n\n\n...\n```\n\n### Good time to put `sev` in action\n```sh\n# First, let's define and initialize environment variables:\nexport ADOBE_ANALYTICS_URL=//assets.adobedtm.com/sc99ai/a9da01/launch-dif9-staging.min.js\nexport GOOGLE_ANALYTICS_URL=//test.url.com/?utm_source=newsletter&utm_medium=banner&utm_campaign=spring_sale\n\nexport VAR_NAMES_STORAGE=ADOBE_ANALYTICS_URL,GOOGLE_ANALYTICS_URL\n\n# execute sev\nsev /html/index.html\n```\n\n### Sample `sev` output\n```sh\n##### START SEV ANNOUNCEMENT ##### \n \n## Target environment variables \n ADOBE_ANALYTICS_URL=//assets.adobedtm.com/sc99ai/a9da01/launch-dif9-staging.min.js\n GOOGLE_ANALYTICS_URL=//test.url.com/?utm_source=newsletter&utm_medium=banner&utm_campaign=spring_sale\n \n \n## Sets of values \nN/A \n \n## Mode \n Pulling values for variables from environment \n \n###### END SEV ANNOUNCEMENT ###### \n \n2020/04/20 13:01:51 INFO: sev succeeded: /html/index.html \n```\n\n### Checking `index.html` processed by `sev`\n```sh=\n...\n\n\n...\n```\n\n## Final Docker Image\nThe final Docker image implemented with `sev`makes maintenance of our application's parameters simple, straight-forward and informative\n### Dockerfile\n```Dockerfile=\nFROM nginx:alpine\n\n# copy nginx configuration\nCOPY nginx/default.conf /etc/nginx/conf.d/\n\n# copy static content\nCOPY dist/ /html\n\n# developers explicitly define and maintain VAR_NAMES_STORAGE in Dockerfile so that operations engineers could always use it as a reference and source of truth for the list of configuration parameters\nENV VAR_NAMES_STORAGE ADOBE_ANALYTICS_URL,GOOGLE_ANALYTICS_URL\n\n# run sev and then run nginx\nCMD [\"/bin/sh\", \"-c\", \"sev /html && nginx -g 'daemon off;'\"]\n```\n\n# Explaining `how sev works`\n## Syntax\n`sev` `/html/index.html`\n* `/html/index.html` is `destination`\n* `destination` can be `path to a file`\n* or `path to a directory`\n## Simple mode (example-1)\nIn this mode we simply replace `placeholders` `in files` with the corresponding `environment variables values`.\n\n### Service environment variables\nWe have a `sevice environment variables` which are used to initialize `sev`.\n#### VAR_NAMES_STORAGE\nStores the `list of environment variables names` which should be processed by `sev`.\n\n##### Example\n```sh=\nexport VAR_NAMES_STORAGE=ADOBE_ANALYTICS_URL,GOOGLE_ANALYTICS_URL\n# you can separate environment variable names with comma\n```\n\n### Processing stage\n* `sev` recursively processes each file provided in `destination`\n* in each file `sev` replaces placeholders like **`_{ENVIRONMENT_VARIABLE}_`** with the corresponding value of `ENVIRONMENT_VARIABLE`\n\n## Pipeline mode (example-2)\nIn this mode we provide a `JSON structure` which contains `sets of values of environment variables` segregated by `identifier`.\n\n### Service environment variables\n#### VAR_NAMES_STORAGE\nServes the same purpose as in `simple mode`\n##### Example\n```sh=\nexport environment-variable-4=some-value-4\nexport check=in_environment\n\nexport VAR_NAMES_STORAGE=environment-variable-4,check\n```\n#### VAR_VALUES_SETS_STORAGE\nStores the `JSON structure` which contains the `sets of values`.\n##### Syntax\n```json\n{\n \"set-of-values-identifier-1\": {\n \"variable-1\": \"the-value-v1-mk1\"\n },\n \"set-of-values-identifier-2\": {\n \"variable-1\": \"the-value-v1-mk2\",\n \"variable-2\": \"the-value-v2\"\n },\n \"set-of-values-identifier-3\": {\n \"variable-1\": \"the-value-v1-mk3\",\n \"variable-3\": \"the-value-v3\"\n }\n}\n```\n##### Example\n```json=\n{\"akamai-prod\":{\"check\":\"in-structure\",\"cntf_space\":\"9bnj36vfwq8e\",\"cntf_token\":\"asd-AsdAsdAsdAsdAsdD-_AsdAsdAsdAsdAsd-As60\",\"cntf_env\":\"master\",\"chtr_log_level\":0},\"akamai\":{\"cntf_space\":\"asd234asd123asd\",\"cntf_token\":\"asd-AsdAsdAsdAsdAsdD-_AsdAsdAsdAsdAsd-As60\",\"cntf_env\":\"chatr-qa1\",\"chtr_log_level\":1},\"dev\":{\"cntf_space\":\"asd456asd123asd\",\"cntf_token\":\"asd-AsdAsdAsdAsdAsdD-_AsdAsdAsdAsdAsd-As60\",\"cntf_env\":\"chatr-dev\",\"chtr_log_level\":1}}\n```\n#### VAR_VALUES_SETS_CHOSEN_ID\nContains the `identifier` for preferred `set of values`.\n##### Example\n```sh=\nexport VAR_VALUES_SETS_CHOSEN_ID=akamai-prod\n```\n\n#### Sample output\n```sh\n##### START SEV ANNOUNCEMENT #####\n\n## Target environment variables\n environment-variable-4 = some-value-4\n check = in_environment\n\n\n## Sets of values\n► akamai-prod\n akamai\n dev\n\n\n## Fetched values\n chtr_log_level = 0\n check = in-structure\n cntf_space = asd234asd123asd\n cntf_token = asd-AsdAsdAsdAsdAsdD-_AsdAsdAsdAsdAsd-As60\n cntf_env = master\n\n\n## Mode\n Pulling sets of values for variables from JSON structure saved at {env.VAR_VALUES_SETS_STORAGE}\n\n###### END SEV ANNOUNCEMENT ######\n\n2020/04/21 15:01:00 INFO: sev succeeded: test-dir\\sample_to_process\n2020/04/21 15:01:00 INFO: sev succeeded: test-dir\\sub\\sample_to_process\n\nProcess finished with exit code 0\n\n```\n\n#### Important note\nIf you have `environment variable` intialized both in `JSON struct` and in the `environment` then the `value` taken from `environment` will prevail and get higher priority.","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",7237590,"orgData",{"_86":87,"_88":89,"_90":91,"_92":29,"_93":94,"_95":96,"_97":94,"_98":99,"_100":101,"_102":103,"_104":105,"_106":105,"_107":17},"id","16eea18c6c35455e8430f066d9dd58eb","uuid","16eea18c-6c35-455e-8430-f066d9dd58eb","type","organization","orgname","full_name","Lean Delivery","location","Belarus","company","profile_url","https://lean-delivery.com/","date_joined","2018-07-16T10:50:49.373723Z","gravatar_url","https://www.gravatar.com/avatar/4472744350718e247c830b540e85a075?s=80&r=g&d=mm","gravatar_email","","badge","is_active","recentTags",[110],{"_111":40,"_112":113,"_114":115,"_86":116,"_117":118,"_46":135,"_136":113,"_137":29,"_138":52,"_53":139,"_140":141,"_142":126,"_143":135,"_144":62,"_145":17},"content_type","creator",3534866,"full_size",3620977,93795103,"images",[119],{"_120":121,"_122":123,"_124":105,"_125":126,"_127":128,"_129":130,"_131":105,"_132":-5,"_133":115,"_59":62,"_134":-5},"architecture","amd64","digest","sha256:1f4a6fc6654281870c52df532e96e9508c32dd06e325643952159076856be751","features","last_pulled","2026-09-24T19:20:40.356585042Z","last_pushed","2020-04-29T09:59:19Z","os","linux","os_features","os_version","size","variant","2020-04-29T09:59:18.31119Z","last_updater","last_updater_username","media_type","latest","repository",8766083,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":157,"_164":165,"_153":174,"_175":11},{"_36":158,"_38":159,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":160,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":161,"_75":11,"_76":163,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":162},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_166":60,"_167":-5,"_168":-5,"_169":170},"count","next","previous","results",[171],{"_111":40,"_112":113,"_114":115,"_86":116,"_117":172,"_46":135,"_136":113,"_137":29,"_138":52,"_53":139,"_140":141,"_142":126,"_143":135,"_144":62,"_145":17},[173],{"_120":121,"_122":123,"_124":105,"_125":126,"_127":128,"_129":130,"_131":105,"_132":-5,"_133":115,"_59":62,"_134":-5},[],"canDeleteTags","actionData","errors"]

leandelivery/filesubst

Tags for leandelivery/filesubst