Три месяца назад мы перестали использовать файлы env в качестве опции экспорта по умолчанию в Doppler CLI. Это изменение привело к ряду преимуществ, включая поддерживающие многопроизводительные переменные и детерминированную схему. Прежде чем идти слишком глубоко на техническом варианте, который мы сделали, давайте сначала перейдемся на то, какие файлы env есть и как они используются.
ENV-файлы – это обычные текстовые файлы, которые хранят переменные и секреты, которые вы не захотите жесткодируемые в вашей кодовой базе. Эти переменные могут быть номером порта или URL-адрес базы данных и могут изменяться в зависимости от того, где ваш код развернут. Например, при разработке локально вы можете использовать порт 3000, но при развернутии к Heroku ваше приложение нужно будет использовать порт, который он динамически назначен. Пример файла env при разработке локально может выглядеть что-то подобное с схемой Ключ = значение :
PORT="3000" DATABASE_URL="psql://postgres@localhost/db_name" AWS_KEY="rfiunb34fu93n49iufgn3o2o0ini2ef" BUGSNAG_API_KEY="33dasdk34bsf23f35871as0fa27" INTERCOM_KEY="ndeiovnkofrnij30490398u39RIBF39IOENIOWF3ENWKEWENVIO" MAILGUN_KEY="fdjnbvjoenvlmswsdnjoelfv" NEW_RELIC_LICENSE_KEY="b583d4eab955872122843a067faca9db5d4202af" NEW_RELIC_LOG="stdout" SALESFORCE_TOKEN="feojkvndfjkovnskfn3eni32one" STRIPE_KEY="sk_test_ejidsfnvoiuebnfvoi3enjkdNCJSB"
Наличие файла недостаточно, хотя вам также нужен инструмент, такой как Форман разбирать файл и ввести эти переменные в среду.
Так каковы некоторые из преимуществ использования файла env? Ну, эти файлы живут на вашем локальном компьютере, что означает, что вам не нужно сетевое соединение, чтобы получить свои секреты. Схема также довольно проста, поэтому легко зайдите в файл и добавить новую переменную. Наконец, все знают этот формат, поэтому в сообществе открытого исходного кода и менеджеров есть тонна поддержки.
С нашего времени работы с файлами ENV и добавлением поддержки для различных случаев использования мы обнаружили, что не существует стандартизированной схемы все библиотеки. Например, посмотрите на образец файла ENV ниже:
PORT = 3030
Обратите внимание, что этот файл env, который содержит пробелы между Ключ и ЦЕНИТЬ . Если бы мы использовали Bash, чтобы ввести переменную в среду с Источник Команда мы получим ошибку.
source spaces.env # >> bash: PORT: command not found
Теперь, если мы используем другой инструмент, как Форман Мы бы увидели это разбираться без ошибки. Это связано с тем, что каждая библиотека определяет схему файла env вместо строго после открытого стандарта. Эти несоответствия вызывают также возникающие другие проблемы, такие как разборные многострочные секреты. В этом примере переменная использует закодированные нью-новинки через \ N. :
CERT="-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEA6ONkkK5eT0wUIjV4CyeO5yQ4AMmCTUyfahKq3gOto4UVhtHE\nlw6GnZwbvRUSwpqGi1X8iTo1GKjcYBVNvRf6Hw5zk9wGTImwNBAlEF7K1aYnelMk\nqDLJ7T0vHAVEvAq2Wz24SljMWgdv9d83KOvuTjZE04H7YlBS4w3OeRu7D2+kgkAr\nR3fqCNEUOvafikwqThHV27xSMaj7uvvm+eMv9ztNb8VauSnZ9zPXtLOPSNy7HGQr\n9S3rqwg7Hif9yLQ2iWVa9R6ACc2I9oK27Olq8AvyHsIz4gktBqLpV3rfBc5muReG\nBO+kdsSpCxpQBQ1W4gU8gTi7Qgr9+bEeaN2bfwIDAQABAoIBAG+J2PRiTtDzwwDP\nUvskqxCRDDF0UW/sLr2Cy0shv9v9NV4owVsHnfmGdtKMcTu6/o1lVVn0AtIYrdNm\n4KCcBzMwnLJIQswNddK5mMbKX6MLvQSdJYVZLdTt5M4qx8y35La2TLlu5hCIV1sO\n2UBEHxJec4BJVLi1d70/M5BVc7Xj/ImqPgHtJhNv5gaej3s/vS1j5YmtCHwGnwbY\ndqVLiY9NgHKO3EOFa0vJplxwR0sIj0WumtkLLwjAfEmt0ivZ3D1fJ9hCFrfpJYwf\nzq9Nv1RL0Jry4SfnWTpXKPlF4N+ateXkNhrZILRg8xmOJSQduYt0wo2KxkAbgxtf\nSidoWIECgYEA+/Ggv0LsqxwmsiR991BA2aurYlJwzEFHL/YUc/j+317yj+vdpOmE\nCCV3mAa9tAgMf+BJvQS1RGS2bnnVe5CcjuoEJ1gQ3LdU9LA1H14880TjMsuxEKkB\nVLHkhiS1yG4lo01H8Aml2EAn1Hz84BazubxMy8vWu6xqm6wT0LIxuI8CgYEA7KM6\ndBtrkWSbj1lpLR8zeLhQkcQP94biLcrH0xEONpphNdTy2DW/Ne6qQWQ9y171iMvU\nOOq+3AcyNf/hZxhRAcTN5Qb3qGUqZn4tRXuVzhKd3CQ5Ijiq7EAfSUI+NBKGPChL\ndX7unhIgJVgcuuo/qg6J5vOV+FGGpm5Zbu9zBhECgYBBcAruYnWSI+exEWVeXQva\n/YmwKfV+N95DiMjbLmsUnVanJv4UnUpby096vxV6szR76kd8vsJOF1KC80YNqAvh\n2splZaxLh5qbS0Eg+pseHGBeiyVcTGk6FFJkvRgyDNndxm7O29KljlRKDoSnt33K\n2iugKzuE102BTXqAFChx5QKBgEyJeuWE3OTYwou54o/KkK5SBxUuce+ge9VNyhXV\nZWB5zElKCAWwVJkQCZc+4dG+c/H74zdJjdPCrBXVHkVnEwRccC/MchvQJMejtebM\nUyak1NQYDzanV3k0QCpEt7PF7g7VBZsKJAmSWT1a42f9Tfwl2aqOTIpVbBS2ikyc\nO/rRAoGARmMBi0jfi1m3DpRt35QyCWJXd8YNGxsaB1cc/NorBPOX5cIP3YGn1b6F\n6kS0HEz1SOpENczi+C5hJiyldVIkek9sjoW7+6030HZlb0U2nnTFCTNfjhcD2+Xa\nNxB4RWiMLTgeDmGICV4U+1qIFLyiuZxabLxw0q5O2kkyGGKlpeQ=\N-----END RSA PRIVATE KEY-----\n"
Эта новая линия обрабатывается по-разному в зависимости от того, какой инструмент вы используете. Использование команды источника Bash A \ N в строке не будет преобразована в Newline символов. С другой стороны, используя самую популярную Env библиотеку Python Доценв автоматически преобразует \ n до ньюгольников. Теперь давайте посмотрим на обратное:
CERT="-----BEGIN RSA PRIVATE KEY----- MIIEogIBAAKCAQEA6ONkkK5eT0wUIjV4CyeO5yQ4AMmCTUyfahKq3gOto4UVhtHE lw6GnZwbvRUSwpqGi1X8iTo1GKjcYBVNvRf6Hw5zk9wGTImwNBAlEF7K1aYnelMk qDLJ7T0vHAVEvAq2Wz24SljMWgdv9d83KOvuTjZE04H7YlBS4w3OeRu7D2+kgkAr R3fqCNEUOvafikwqThHV27xSMaj7uvvm+eMv9ztNb8VauSnZ9zPXtLOPSNy7HGQr 9S3rqwg7Hif9yLQ2iWVa9R6ACc2I9oK27Olq8AvyHsIz4gktBqLpV3rfBc5muReG BO+kdsSpCxpQBQ1W4gU8gTi7Qgr9+bEeaN2bfwIDAQABAoIBAG+J2PRiTtDzwwDP UvskqxCRDDF0UW/sLr2Cy0shv9v9NV4owVsHnfmGdtKMcTu6/o1lVVn0AtIYrdNm 4KCcBzMwnLJIQswNddK5mMbKX6MLvQSdJYVZLdTt5M4qx8y35La2TLlu5hCIV1sO 2UBEHxJec4BJVLi1d70/M5BVc7Xj/ImqPgHtJhNv5gaej3s/vS1j5YmtCHwGnwbY dqVLiY9NgHKO3EOFa0vJplxwR0sIj0WumtkLLwjAfEmt0ivZ3D1fJ9hCFrfpJYwf zq9Nv1RL0Jry4SfnWTpXKPlF4N+ateXkNhrZILRg8xmOJSQduYt0wo2KxkAbgxtf SidoWIECgYEA+/Ggv0LsqxwmsiR991BA2aurYlJwzEFHL/YUc/j+317yj+vdpOmE CCV3mAa9tAgMf+BJvQS1RGS2bnnVe5CcjuoEJ1gQ3LdU9LA1H14880TjMsuxEKkB VLHkhiS1yG4lo01H8Aml2EAn1Hz84BazubxMy8vWu6xqm6wT0LIxuI8CgYEA7KM6 dBtrkWSbj1lpLR8zeLhQkcQP94biLcrH0xEONpphNdTy2DW/Ne6qQWQ9y171iMvU OOq+3AcyNf/hZxhRAcTN5Qb3qGUqZn4tRXuVzhKd3CQ5Ijiq7EAfSUI+NBKGPChL dX7unhIgJVgcuuo/qg6J5vOV+FGGpm5Zbu9zBhECgYBBcAruYnWSI+exEWVeXQva /YmwKfV+N95DiMjbLmsUnVanJv4UnUpby096vxV6szR76kd8vsJOF1KC80YNqAvh 2splZaxLh5qbS0Eg+pseHGBeiyVcTGk6FFJkvRgyDNndxm7O29KljlRKDoSnt33K 2iugKzuE102BTXqAFChx5QKBgEyJeuWE3OTYwou54o/KkK5SBxUuce+ge9VNyhXV ZWB5zElKCAWwVJkQCZc+4dG+c/H74zdJjdPCrBXVHkVnEwRccC/MchvQJMejtebM Uyak1NQYDzanV3k0QCpEt7PF7g7VBZsKJAmSWT1a42f9Tfwl2aqOTIpVbBS2ikyc O/rRAoGARmMBi0jfi1m3DpRt35QyCWJXd8YNGxsaB1cc/NorBPOX5cIP3YGn1b6F 6kS0HEz1SOpENczi+C5hJiyldVIkek9sjoW7+6030HZlb0U2nnTFCTNfjhcD2+Xa NxB4RWiMLTgeDmGICV4U+1qIFLyiuZxabLxw0q5O2kkyGGKlpeQ= -----END RSA PRIVATE KEY-----"
В этом примере у нас есть тот же сертификат, но с новыми символами. Удивительно, что команда источника Bash уважает новенький характер, но в библиотеке Node Dotenv нет. Очитывается более интересно, так как библиотека узла перерывается. Он анализирует ценность как «—– начните закрытый ключ RSA —– и игнорирует все остальные строки. Я также нахожу это смешно, что потому, что это многострочная переменная алгоритм обнаружения цитата, который можно увидеть первым персонажем, являющимся кавычностью. Если алгоритм обнаружения цитата работал правильно, вы увидите, что значение будет ограничено его кавычками в начале и конце строки.
После реализации файлов env проблематично, мы начали смотреть на альтернативы. Мы хотели то, что имеет универсально принятую схему без комнаты для интерпретации и большого сообщества для поддержки. Две форматы данных, на которых мы сосредоточены, были ЯМЛ и JSON.
Давайте начнем с YAML. Одним из основных преимуществ YAML является то, что это невероятно легко читать и писать. Он использует отступ и вложенность как способ обозначения структуры. Давайте посмотрим на образец файла yaml:
PORT: 3000 DATABASE_URL: "psql://postgres@localhost/db_name" AWS_KEY: "rfiunb34fu93n49iufgn3o2o0ini2ef" CERT: | -----BEGIN RSA PRIVATE KEY----- MIIEogIBAAKCAQEA6ONkkK5eT0wUIjV4CyeO5yQ4AMmCTUyfahKq3gOto4UVhtHE lw6GnZwbvRUSwpqGi1X8iTo1GKjcYBVNvRf6Hw5zk9wGTImwNBAlEF7K1aYnelMk qDLJ7T0vHAVEvAq2Wz24SljMWgdv9d83KOvuTjZE04H7YlBS4w3OeRu7D2+kgkAr R3fqCNEUOvafikwqThHV27xSMaj7uvvm+eMv9ztNb8VauSnZ9zPXtLOPSNy7HGQr 9S3rqwg7Hif9yLQ2iWVa9R6ACc2I9oK27Olq8AvyHsIz4gktBqLpV3rfBc5muReG BO+kdsSpCxpQBQ1W4gU8gTi7Qgr9+bEeaN2bfwIDAQABAoIBAG+J2PRiTtDzwwDP UvskqxCRDDF0UW/sLr2Cy0shv9v9NV4owVsHnfmGdtKMcTu6/o1lVVn0AtIYrdNm 4KCcBzMwnLJIQswNddK5mMbKX6MLvQSdJYVZLdTt5M4qx8y35La2TLlu5hCIV1sO 2UBEHxJec4BJVLi1d70/M5BVc7Xj/ImqPgHtJhNv5gaej3s/vS1j5YmtCHwGnwbY dqVLiY9NgHKO3EOFa0vJplxwR0sIj0WumtkLLwjAfEmt0ivZ3D1fJ9hCFrfpJYwf zq9Nv1RL0Jry4SfnWTpXKPlF4N+ateXkNhrZILRg8xmOJSQduYt0wo2KxkAbgxtf SidoWIECgYEA+/Ggv0LsqxwmsiR991BA2aurYlJwzEFHL/YUc/j+317yj+vdpOmE CCV3mAa9tAgMf+BJvQS1RGS2bnnVe5CcjuoEJ1gQ3LdU9LA1H14880TjMsuxEKkB VLHkhiS1yG4lo01H8Aml2EAn1Hz84BazubxMy8vWu6xqm6wT0LIxuI8CgYEA7KM6 dBtrkWSbj1lpLR8zeLhQkcQP94biLcrH0xEONpphNdTy2DW/Ne6qQWQ9y171iMvU OOq+3AcyNf/hZxhRAcTN5Qb3qGUqZn4tRXuVzhKd3CQ5Ijiq7EAfSUI+NBKGPChL dX7unhIgJVgcuuo/qg6J5vOV+FGGpm5Zbu9zBhECgYBBcAruYnWSI+exEWVeXQva /YmwKfV+N95DiMjbLmsUnVanJv4UnUpby096vxV6szR76kd8vsJOF1KC80YNqAvh 2splZaxLh5qbS0Eg+pseHGBeiyVcTGk6FFJkvRgyDNndxm7O29KljlRKDoSnt33K 2iugKzuE102BTXqAFChx5QKBgEyJeuWE3OTYwou54o/KkK5SBxUuce+ge9VNyhXV ZWB5zElKCAWwVJkQCZc+4dG+c/H74zdJjdPCrBXVHkVnEwRccC/MchvQJMejtebM Uyak1NQYDzanV3k0QCpEt7PF7g7VBZsKJAmSWT1a42f9Tfwl2aqOTIpVbBS2ikyc O/rRAoGARmMBi0jfi1m3DpRt35QyCWJXd8YNGxsaB1cc/NorBPOX5cIP3YGn1b6F 6kS0HEz1SOpENczi+C5hJiyldVIkek9sjoW7+6030HZlb0U2nnTFCTNfjhcD2+Xa NxB4RWiMLTgeDmGICV4U+1qIFLyiuZxabLxw0q5O2kkyGGKlpeQ= -----END RSA PRIVATE KEY-----
На первый взгляд синтаксис выглядит очень похоже на формат env, но когда мы смотрим ближе, мы видим тонкие различия. Синтаксис YAML использует двоеточия вместо знаков равных знаков и имеет нативную поддержку для многострочных строк. Один недостаток при использовании многострочных секретов заключается в том, что вдавливание действительно имеет значение. Легендарные дискуссии о том, сколько пробелов равен вкладке вкладки. С помощью разработчиков каждый имел свой собственный стиль, он может сделать файлы yaml, подверженные разбору ошибок при совместном использовании.
JSON с другой стороны имеет дико разный синтаксис, затем ямл. Wikipedia имеет точное описание языка:
Обзор JavaScript – это открытый стандартный формат файла, а формат обмена данными, который использует читаемый человеком текст для хранения и передачи объектов данных, состоящий из пар атрибутов, и типов данных массива (или любого другого серийного значения). Давайте посмотрим на тот же конфигурацию переменных в формате JSON:
{
"PORT": "3000",
"DATABASE_URL": "psql://postgres@localhost/db_name",
"AWS_KEY": "rfiunb34fu93n49iufgn3o2o0ini2ef",
"CERT": "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEA6ONkkK5eT0wUIjV4CyeO5yQ4AMmCTUyfahKq3gOto4UVhtHE\nlw6GnZwbvRUSwpqGi1X8iTo1GKjcYBVNvRf6Hw5zk9wGTImwNBAlEF7K1aYnelMk\nqDLJ7T0vHAVEvAq2Wz24SljMWgdv9d83KOvuTjZE04H7YlBS4w3OeRu7D2+kgkAr\nR3fqCNEUOvafikwqThHV27xSMaj7uvvm+eMv9ztNb8VauSnZ9zPXtLOPSNy7HGQr\n9S3rqwg7Hif9yLQ2iWVa9R6ACc2I9oK27Olq8AvyHsIz4gktBqLpV3rfBc5muReG\nBO+kdsSpCxpQBQ1W4gU8gTi7Qgr9+bEeaN2bfwIDAQABAoIBAG+J2PRiTtDzwwDP\nUvskqxCRDDF0UW/sLr2Cy0shv9v9NV4owVsHnfmGdtKMcTu6/o1lVVn0AtIYrdNm\n4KCcBzMwnLJIQswNddK5mMbKX6MLvQSdJYVZLdTt5M4qx8y35La2TLlu5hCIV1sO\n2UBEHxJec4BJVLi1d70/M5BVc7Xj/ImqPgHtJhNv5gaej3s/vS1j5YmtCHwGnwbY\ndqVLiY9NgHKO3EOFa0vJplxwR0sIj0WumtkLLwjAfEmt0ivZ3D1fJ9hCFrfpJYwf\nzq9Nv1RL0Jry4SfnWTpXKPlF4N+ateXkNhrZILRg8xmOJSQduYt0wo2KxkAbgxtf\nSidoWIECgYEA+/Ggv0LsqxwmsiR991BA2aurYlJwzEFHL/YUc/j+317yj+vdpOmE\nCCV3mAa9tAgMf+BJvQS1RGS2bnnVe5CcjuoEJ1gQ3LdU9LA1H14880TjMsuxEKkB\nVLHkhiS1yG4lo01H8Aml2EAn1Hz84BazubxMy8vWu6xqm6wT0LIxuI8CgYEA7KM6\ndBtrkWSbj1lpLR8zeLhQkcQP94biLcrH0xEONpphNdTy2DW/Ne6qQWQ9y171iMvU\nOOq+3AcyNf/hZxhRAcTN5Qb3qGUqZn4tRXuVzhKd3CQ5Ijiq7EAfSUI+NBKGPChL\ndX7unhIgJVgcuuo/qg6J5vOV+FGGpm5Zbu9zBhECgYBBcAruYnWSI+exEWVeXQva\n/YmwKfV+N95DiMjbLmsUnVanJv4UnUpby096vxV6szR76kd8vsJOF1KC80YNqAvh\n2splZaxLh5qbS0Eg+pseHGBeiyVcTGk6FFJkvRgyDNndxm7O29KljlRKDoSnt33K\n2iugKzuE102BTXqAFChx5QKBgEyJeuWE3OTYwou54o/KkK5SBxUuce+ge9VNyhXV\nZWB5zElKCAWwVJkQCZc+4dG+c/H74zdJjdPCrBXVHkVnEwRccC/MchvQJMejtebM\nUyak1NQYDzanV3k0QCpEt7PF7g7VBZsKJAmSWT1a42f9Tfwl2aqOTIpVbBS2ikyc\nO/rRAoGARmMBi0jfi1m3DpRt35QyCWJXd8YNGxsaB1cc/NorBPOX5cIP3YGn1b6F\n6kS0HEz1SOpENczi+C5hJiyldVIkek9sjoW7+6030HZlb0U2nnTFCTNfjhcD2+Xa\nNxB4RWiMLTgeDmGICV4U+1qIFLyiuZxabLxw0q5O2kkyGGKlpeQ=\n-----END RSA PRIVATE KEY-----\n"
}
Одним из главных красот JSON является то, что он строго принудился, и есть только один способ выполнения каждой задачи. Например, когда мы смотрим на переменную Порт , мы видим, что значение завернуто в цитаты, чтобы указать, что это строка. В отличие от YAML, который будет угадать, должен ли строка в строку или номер, JSON имеет только один из способов отмены строк и цифр. Одна иначая разница в ярких ситуациях между YAML и JSON – это то, как они обрабатывают многострочные переменные. В JSON мы видим, что он использует закодированные новинки \, которые мы считаем более безопасной ставкой, чем доверительные люди с отступом.
Мы заканчивались с JSON, потому что у него есть схема далеко и имеет сильную нативную поддержку на большинстве языков. После того, как выключатель, мы увидели проблемы наших клиентов с разбором загружены файлы конфигурации плоской линии. С Doppler CLI Создает отступление ваших секретов по умолчанию при запуске приложения, мы решили понять еще один шаг, включив шифрование по умолчанию.
Мы настоятельно полагаем, что вы всегда будете ухудшаться, имея секреты на диске, но если вы собираетесь, это обязательно, чтобы они зашифрованы.
Надоело управлять парком секретов вручную с помощью копирования/вставки? Хотите, чтобы конечный управляемый менеджер секретов, который хранится на все ваши секреты в одном месте, имеет встроенный вариант управления и контроль доступа? Попробуй допплер. Он отлично работает в местном развитии (попрощайтесь до файлов env) и в производстве, плюс его без усилий масштабирует с вами как ваша команда и продукты. Посмотрите на наш быстрый Установить Руководство Чтобы увидеть, если это подходит для вашей команды.
Оригинал: “https://dev.to/doppler/goodbye-env-files-ke5”