Compare commits
634 Commits
Author | SHA1 | Date |
---|---|---|
Mascali | b402f8309e | |
Tobias Genannt | 39c7de4af4 | |
Tobias Genannt | 238f95c5ce | |
Christian Mäder | 751a131b78 | |
Tobias Genannt | 5e2158da24 | |
Tobias Genannt | 4a530947f8 | |
Tobias Genannt | bdb4396275 | |
Tobias Genannt | 80d87bdf1b | |
Tobias Genannt | 6d465e6f81 | |
Tobias Genannt | b72084290a | |
Tobias Genannt | aa3357817a | |
Tobias Genannt | 9441be459c | |
Tobias Genannt | 1779ba790d | |
Tobias Genannt | 22cb2d5812 | |
Christian Mäder | 6020f4503a | |
renovate[bot] | a4f494db14 | |
Tobias Genannt | 0cac6f51a9 | |
Wellyas | dd01e3c227 | |
Tobias Genannt | 925f41b97f | |
movelg | 7d871778eb | |
Christian Mäder | 8b16b16e45 | |
Christian Mäder | c5f91ad359 | |
Ryan Merolle | 35a94cb7e5 | |
Christian Mäder | 1835d3cafd | |
Christian Mäder | df8f406432 | |
Christian Mäder | b8b1c8fc63 | |
Christian Mäder | 41ff541225 | |
Christian Mäder | 26399e224d | |
Christian Mäder | 951c12132a | |
Christian Mäder | a3680b22dd | |
Christian Mäder | d96e8f1dfd | |
Christian Mäder | c21a29b383 | |
Christian Mäder | f9f1533332 | |
renovate[bot] | 4f45df571f | |
Delta / Subo /Stefan | cd5015642e | |
Tobias Genannt | d385cd2aa9 | |
Vincent Catros | 7f285af7b4 | |
Tobias Genannt | c8c360da99 | |
Michal Tyminski | 53dcdc7bfc | |
Tobias Genannt | 3f1e45f636 | |
Tobias Genannt | e38c1d3c85 | |
Tobias Genannt | e48ab084ce | |
Tobias Genannt | 5ea3008f82 | |
Tobias Genannt | 1418808930 | |
Tobias Genannt | da412e3bdb | |
Tobias Genannt | 98add8f83a | |
Tobias Genannt | 6f1d46d765 | |
Tobias Genannt | ada2bd6501 | |
Tobias Genannt | 8707cef55a | |
Tobias Genannt | dc45dfc383 | |
renovate[bot] | 691ad94498 | |
Tobias Genannt | 535fefe12f | |
renovate[bot] | db982814a1 | |
Tobias Genannt | ebda4660de | |
Tobias Genannt | f44e377e29 | |
Tobias Genannt | 0a6d4c998d | |
Tobias Genannt | bd9733d929 | |
Tobias Genannt | 9ae3282dcf | |
Tobias Genannt | e62fedbd5e | |
Tobias Genannt | c53ae2afa0 | |
Tobias Genannt | 45e7f6a30c | |
Tobias Genannt | 8fbedf2886 | |
renovate[bot] | c0063a6573 | |
Tobias Genannt | c9795a8213 | |
renovate[bot] | 8aec402ea2 | |
Tobias Genannt | adc2079b17 | |
Tobias Genannt | cee1b5b079 | |
Tobias Genannt | 13d66f2ae7 | |
Tobias Genannt | 901ac05e99 | |
Robert Meredith | 2bdaed1e6f | |
Tobias Genannt | b45934cd9e | |
Tobias Genannt | fceb6e0e13 | |
Tobias Genannt | f05a9c67ae | |
Tobias Genannt | f2d1e62204 | |
renovate[bot] | 8f704f220a | |
Tobias Genannt | d5093201ee | |
Tobias Genannt | 401777adff | |
Vincent Catros | 5ff292ba5f | |
Tobias Genannt | f80cc70d76 | |
Tobias Genannt | 5b8bf780df | |
Tobias Genannt | bce52596a5 | |
Tobias Genannt | c3c94b0a63 | |
Tobias Genannt | 14c30fb81c | |
Christian Mäder | 1130ff6c6d | |
SejiL | 993c93b34a | |
Tobias Genannt | dcf0bdb950 | |
Tobias Genannt | 9e2f4313fb | |
Tobias Genannt | df41020cb8 | |
Tobias Genannt | 1332df4857 | |
Tobias Genannt | 3f23419bb7 | |
Renovate Bot | 184ff72912 | |
Renovate Bot | 55ee95df78 | |
Tobias Genannt | 78fe47aaba | |
Tobias Genannt | 1370596f27 | |
Renovate Bot | 606e56d78f | |
Ryan Rawdon | 51226c8e50 | |
Tobias Genannt | 6c9d4aebac | |
Renovate Bot | ed8b42fbde | |
Tobias Genannt | aa56f645e9 | |
Renovate Bot | 9a1bb788d2 | |
Tobias Genannt | 7d32f79379 | |
Tobias Genannt | 0410cf2fd2 | |
Tobias Genannt | c9f5e34c0d | |
Thompson, Lon | 047f2abdb5 | |
Tobias Genannt | f13a6573a8 | |
Thomas McWork | 596bb6953c | |
kr3ator | d482e623df | |
Thomas McWork | bf910dea02 | |
kr3ator | 57da852af6 | |
Tobias Genannt | 4c21344e8b | |
kr3ator | 302c0fed59 | |
kr3ator | 0e7afe466d | |
Tobias Genannt | 2c757af250 | |
Tobias Genannt | 27f28935d7 | |
kr3ator | 12753dd7d4 | |
kr3ator | dd8dce1b49 | |
Robin Beismann | 19280c2bb0 | |
Tobias Genannt | 5c4a1cc082 | |
kr3ator | a63af05bec | |
kr3ator | 9be7b0e109 | |
Robin Beismann | d5b1d9ce39 | |
Tobias Genannt | a6eb4fef00 | |
kr3ator | d1c69e8fe5 | |
kr3ator | 81d9e4f560 | |
Tobias Genannt | 61a3afbb3b | |
Tobias Genannt | 91ab616cc5 | |
Tobias Genannt | 43d62f1284 | |
Tobias Genannt | d61470d6ef | |
Tobias Genannt | 091d23d537 | |
Renovate Bot | 2f24902436 | |
Tobias Genannt | 36d47b9b88 | |
Renovate Bot | 2c20771682 | |
Tobias Genannt | a9cdec6d87 | |
Renovate Bot | f1efccea6b | |
Tobias Genannt | 226d8438de | |
Tobias Genannt | b6d6f85dc0 | |
Tobias Genannt | 49ed10bbee | |
Tobias Genannt | 3afdd3bf13 | |
Christian Mäder | 0170ed7d6f | |
Renovate Bot | dad2e93572 | |
Tobias Genannt | d726426611 | |
Renovate Bot | b31d99b936 | |
Ryan Merolle | 8860d32f97 | |
Tobias Genannt | b9dff0d22e | |
Tobias Genannt | 297aab1fd3 | |
Christian Mäder | 54bf7a3819 | |
ryanmerolle | 52876be723 | |
Tobias Genannt | ff20e4f49c | |
Tobias Genannt | ee47ba04bc | |
Christian Mäder | 688374d13f | |
Renovate Bot | 22c4212438 | |
Christian Mäder | 26dcb2f2e0 | |
Renovate Bot | 46afa266fa | |
Tobias Genannt | b2d26d9dce | |
Tobias Genannt | 0b622361f3 | |
Tobias Genannt | ed48909f96 | |
Tobias Genannt | 60d191bb2a | |
Tobias Genannt | 4f482e484f | |
Tobias Genannt | 58a1579832 | |
Tobias Genannt | 6d5cf7a815 | |
Tobias Genannt | 2e92554423 | |
Tobias Genannt | 2456a642b7 | |
Tobias Genannt | b5108625ff | |
Tobias Genannt | 9ab54f27b1 | |
Tobias Genannt | 4b7037bbe6 | |
Tobias Genannt | f183603bc0 | |
Tobias Genannt | 544a58325d | |
Renovate Bot | 9557bdf209 | |
Tobias Genannt | 4890a8510d | |
Renovate Bot | 66f77b5eb1 | |
Tobias Genannt | 661b6b07a3 | |
Uwe Grawert | ce8db1065d | |
Tobias Genannt | 9a0e1115ed | |
Tobias Genannt | 2b4c058af8 | |
Tobias Genannt | a206ad6811 | |
Tobias Genannt | a1dabcb758 | |
Christian Mäder | 940c1bb50c | |
Christian Mäder | 6c49d4fef5 | |
cimnine | 621df33df9 | |
cimnine | 7e86ba002f | |
cimnine | 6f12cb36af | |
cimnine | 4ef35aadb6 | |
Renovate Bot | d4081c15e1 | |
Christian Mäder | 6e870b4d0b | |
Christian Mäder | 1e78ccd204 | |
Renovate Bot | 84e9b63524 | |
cimnine | 4cc7f13b6e | |
Tobias Genannt | fc2d0d1852 | |
Tobias Genannt | ef98ad54fa | |
Tobias Genannt | 4785e09945 | |
Tobias Genannt | d4f9bb6da3 | |
rsp2k | ab41eaa5d9 | |
rsp2k | 02794f368b | |
Tobias Genannt | 9c66cc4c32 | |
Christian Mäder | 68401caf1c | |
Renovate Bot | 4f466bb5a1 | |
Christian Mäder | daaea77144 | |
Christian Mäder | faa1cb52dd | |
Christian Mäder | 57ac14f295 | |
Renovate Bot | d0f4820baa | |
Christian Mäder | b0261e8cc6 | |
Christian Mäder | 30a7aa0e9c | |
Christian Mäder | 5f0b7467d1 | |
Christian Mäder | 24363b653f | |
Christian Mäder | 21a3048b96 | |
Tobias Genannt | 5679ab435f | |
Christian Mäder | c9b3edd0f1 | |
Renovate Bot | 31e6e42a30 | |
Christian Mäder | 1a868c6847 | |
cimnine | a9d6f1fefe | |
cimnine | dbfcd5b58c | |
Tobias Genannt | 6a52a48b71 | |
Tobias Genannt | e31492a9b4 | |
Tobias Genannt | f2dbc4f717 | |
Tobias Genannt | 1d040ad64d | |
Tobias Genannt | 8703749292 | |
Tobias Genannt | d432a84c42 | |
Tobias Genannt | c00492cad0 | |
Tobias Genannt | c4d545a256 | |
Tobias Genannt | d0c429c8a1 | |
Tobias Genannt | a8b6883183 | |
Tobias Genannt | 5590b32c93 | |
Renovate Bot | 97e7022121 | |
Tobias Genannt | 2926d1a11d | |
Tobias Genannt | 58debafa8a | |
Tobias Genannt | e021390568 | |
Tobias Genannt | 389e68f6ba | |
Tobias Genannt | 7eeb2ea7e6 | |
Christian Mäder | 954bddeb64 | |
Christian Mäder | 9255afd060 | |
Daniel Metzler | a0a32b930e | |
Mike Kazantsev | fc4b78f74a | |
Tobias Genannt | 9e063a6e6f | |
Tobias Genannt | 54823b41e1 | |
Tobias Genannt | 6c5434ee20 | |
Tobias Genannt | 8e0c795791 | |
Tobias Genannt | 1fd8d105e6 | |
Christian Mäder | fe4df4f70a | |
Christian Mäder | 650e62f44f | |
Tobias Genannt | f8451b0c0a | |
Renovate Bot | 3af075e039 | |
Christian Mäder | 26d45b1e85 | |
Renovate Bot | 9b6c476bf9 | |
Tobias Genannt | c5a1557800 | |
Tobias Genannt | 9d476fa9af | |
Tobias Genannt | 9142aaf78e | |
Christian Mäder | b258b6578c | |
Renovate Bot | 289540f576 | |
Christian Mäder | 26a3f5fcc0 | |
Renovate Bot | 18ea220102 | |
Tobias Genannt | 03a1793208 | |
Christian Mäder | 3c01985e20 | |
Renovate Bot | 275d2673b4 | |
Tobias Genannt | 746aa9b4a6 | |
Tobias Genannt | c13bec47b8 | |
Tobias Genannt | 9953d11fd8 | |
Tobias Genannt | b2ee468871 | |
Ageev Pavel | dd41d09b43 | |
Renovate Bot | abfa6c989f | |
Christian Mäder | bb3d964b89 | |
Renovate Bot | 6bbc7a3a84 | |
Christian Mäder | 17b1a5022d | |
Renovate Bot | e38d646e8e | |
Christian Mäder | bb298e7a01 | |
Renovate Bot | 98840382b9 | |
Christian Mäder | b8ff0a1d43 | |
Jelizaveta Lemeševa | 15b097bd3e | |
Christian Mäder | e0b34b8c67 | |
Renovate Bot | 3aad44d68c | |
Christian Mäder | 6658d069fb | |
Christian Mäder | 52f097d4a2 | |
Renovate Bot | f4e9ebcfb5 | |
Jelizaveta Lemeševa | 057728b774 | |
Christian Mäder | 5b618851c0 | |
Christian Mäder | 9f531ce0f7 | |
Renovate Bot | dd732d7bc2 | |
Tobias Genannt | 05bb40adb1 | |
Renovate Bot | 240326ef37 | |
Tobias Genannt | c49fa313ed | |
Tobias Genannt | ff6bd95fce | |
Tobias Genannt | 0def662e53 | |
Renovate Bot | 49b7c267b9 | |
Tobias Genannt | 02f30f3a68 | |
Tobias Genannt | e2cc9386fb | |
Tobias Genannt | 43b8b36951 | |
Tobias Genannt | 4d320f34d5 | |
Tobias Genannt | 676ca798cd | |
Christian Mäder | 60428d5639 | |
Tobias Genannt | fd55ec220c | |
Christian Mäder | 73b07a7181 | |
ryanmerolle | 1f3d9463f9 | |
ryanmerolle | 8678ad92ce | |
Tobias Genannt | 5b34df1471 | |
Christian Mäder | 3d063a4b35 | |
Christian Mäder | f924e76adf | |
Christian Mäder | 604ff3b76d | |
ryanmerolle | 96545135cb | |
ryanmerolle | 474ca9e78f | |
ryanmerolle | 12401f2a3f | |
ryanmerolle | 528bc17eb8 | |
ryanmerolle | 4e31218ce6 | |
Christian Mäder | d1b70ba2d4 | |
ryanmerolle | ff0bc9757a | |
ryanmerolle | a1e0c52825 | |
ryanmerolle | 45889c3811 | |
ryanmerolle | 71d8ac10ac | |
ryanmerolle | 744ed91e2a | |
ryanmerolle | b1bcfcbc4e | |
ryanmerolle | a7a5d13637 | |
ryanmerolle | 5d4ecb7f9e | |
ryanmerolle | 69dd87689c | |
ryanmerolle | 9fab9a3434 | |
ryanmerolle | b69a97d2ca | |
ryanmerolle | 8176ef8499 | |
ryanmerolle | eb5cc88b25 | |
Christian Mäder | f2731d3fe6 | |
ryanmerolle | 6f4d025cb7 | |
ryanmerolle | 222ede2c4b | |
Christian Mäder | 5304c8f901 | |
Ryan Merolle | 28a26288c9 | |
Renovate Bot | 53d759e263 | |
Tobias Genannt | 6879412e2b | |
Tobias Genannt | a89d2e035c | |
Tobias Genannt | d5c92e9a7d | |
Tobias Genannt | c7df608696 | |
Christian Mäder | eee07f703a | |
Erick Turnquist | 6e7d5a6f59 | |
Tobias Genannt | 752f592e58 | |
Tobias Genannt | f637de88f0 | |
Christian Mäder | a5da38203f | |
Christian Mäder | 14c0d17704 | |
Renovate Bot | a572d5f5de | |
Tobias Genannt | 3673196c16 | |
Tobias Genannt | 9874cef369 | |
Tobias Genannt | 1c4b6741ac | |
Tobias Genannt | b18e4aaf92 | |
Tobias Genannt | 45824ba4f3 | |
Tobias Genannt | 5944086435 | |
Marcus Crane | a2e33c166d | |
Christian Mäder | 9ab202f921 | |
Renovate Bot | cca79b5dbd | |
Christian Mäder | 61eecdd343 | |
Renovate Bot | ce6fe5cb83 | |
Christian Mäder | 8f119ede13 | |
Christian Mäder | edb61f3d90 | |
Christian Mäder | cb5ffa0354 | |
Renovate Bot | ff1eed3cf0 | |
Christian Mäder | 53d593de25 | |
Christian Mäder | 8111da308b | |
Christian Mäder | 0125ab4849 | |
Christian Mäder | ad0c04985b | |
Christian Mäder | 793393fe0f | |
Christian Mäder | 59995a8719 | |
Ryan Merolle | f19d650412 | |
Christian Mäder | 6cd156f7d5 | |
Christian Mäder | 95976f4cf4 | |
Ryan Merolle | 0dec4d8df4 | |
ryanmerolle | 22186b267d | |
ryanmerolle | 020e0adeb4 | |
Christian Mäder | 009eb1fc6d | |
Christian Mäder | 989c250a82 | |
Christian Mäder | 3ee231bdd8 | |
Renovate Bot | 3338cdc9d7 | |
Christian Mäder | c80fb19507 | |
Christian Mäder | 74543ec272 | |
Christian Mäder | 9ccf0ac921 | |
Christian Mäder | 8aed79363a | |
Christian Mäder | f7337ed1e9 | |
Christian Mäder | 4c8435e874 | |
Christian Mäder | a37f1592fc | |
Christian Mäder | 04ac3d5f4b | |
Christian Mäder | c6df6a040a | |
Christian Mäder | 28e4ae44fb | |
Christian Mäder | 493fc60401 | |
Christian Mäder | 0d25aff744 | |
Christian Mäder | f33c647f24 | |
Christian Mäder | 16ae063321 | |
Schylar Utley | e4e2c788a9 | |
Schylar Utley | 2e5d84612d | |
Schylar Utley | 744f0e57ad | |
Schylar Utley | 52c51b5f99 | |
Schylar Utley | f88f4e1579 | |
Schylar Utley | 95f4d7856a | |
Schylar Utley | 07a0b1d7ef | |
Schylar Utley | fe811f37bd | |
Schylar Utleye | 8321449cc0 | |
Schylar Utleye | 618feff63a | |
Schylar Utleye | a3cf645dc5 | |
Schylar Utleye | d0c786e831 | |
Schylar Utleye | 7112a88359 | |
Schylar Utleye | 187ae4b2a1 | |
Christian Mäder | 3a0b3fe133 | |
Christian Mäder | 5343eaae65 | |
Christian Mäder | 83a0d5d12f | |
Robin Schneider | ee40e339c8 | |
Tobias Genannt | 04e0b3d3ca | |
Christian Mäder | fa70e0b761 | |
Christian Mäder | 88b35eb48e | |
Tobias Genannt | 5644254113 | |
Christian Mäder | 4dd7a51c7d | |
Christian Mäder | c7e259e116 | |
Christian Mäder | 3cbe07cb0e | |
Tobias Genannt | 70b38d52b9 | |
Tobias Genannt | a21d146b60 | |
Christian Mäder | 6e7a64bd81 | |
Renovate Bot | f8360ba6aa | |
Christian Mäder | bab8373f66 | |
Renovate Bot | ad93c99f46 | |
Christian Mäder | ed6256172f | |
Christian Mäder | 5109e340ca | |
Christian Mäder | 62d31fda58 | |
Tobias Genannt | ed141c8a4e | |
Christian Mäder | 4d8d02e35a | |
Tobias Genannt | 96132e1dcc | |
Christian Mäder | 896651ed97 | |
Christian Mäder | f810d0342d | |
Christian Mäder | 323e18278a | |
Schylar Utley | a0f7737916 | |
Schylar Utley | 7f8cc76af6 | |
Christian Mäder | 21bd7f426c | |
Christian Mäder | 3758bc805a | |
Christian Mäder | 72859ca71a | |
Renovate Bot | 0022392f03 | |
Schylar Utley | 385c66e30d | |
Christian Mäder | 65023a7dd4 | |
Tobias Genannt | 426adb2333 | |
Schylar Utley | 584566b0f0 | |
Schylar Utley | 5399f8c890 | |
ryanmerolle | 2372c1eeff | |
ryanmerolle | 788aeacd9b | |
ryanmerolle | 00fa1793d0 | |
ryanmerolle | 4260e9b864 | |
ryanmerolle | 02713e1465 | |
ryanmerolle | 728a16c93d | |
Tobias Genannt | 742560c571 | |
Tobias Genannt | d273391773 | |
Christian Mäder | 380cb77080 | |
Christian Mäder | 92b6608403 | |
ryanmerolle | 94509f86d7 | |
ryanmerolle | 818266ace1 | |
ryanmerolle | dfb0327340 | |
ryanmerolle | e3946af27c | |
ryanmerolle | 8d8c58df54 | |
ryanmerolle | cbaaffc589 | |
ryanmerolle | 0f1cc9eea0 | |
ryanmerolle | 90018fc6d7 | |
ryanmerolle | 621fa12934 | |
ryanmerolle | 3094665092 | |
ryanmerolle | 31f52041f8 | |
ryanmerolle | 6ab38472be | |
Christian Mäder | aa4d630a0f | |
Christian Mäder | 4e8588accf | |
Christian Mäder | 07469b2b72 | |
Christian Mäder | a7c1d9f550 | |
Christian Mäder | 5605b9b218 | |
Christian Mäder | b92c652d99 | |
Christian Mäder | d77b3c1222 | |
Christian Mäder | e383fd42bd | |
Christian Mäder | 234baa40a5 | |
Christian Mäder | 77d3dcded0 | |
Christian Mäder | 349e269356 | |
Christian Mäder | 5c9bea8b50 | |
Christian Mäder | 036f94a450 | |
Christian Mäder | 9d51762161 | |
devon-mar | 4276c941eb | |
Christian Mäder | 3cbdf26773 | |
devon-mar | fbfce46ce5 | |
Tim Oliver Rabl | 255889288c | |
Tobias Genannt | c068db1751 | |
Christian Mäder | 378784a19c | |
Pablo Ruiz | dcb3b5495d | |
Pablo Ruiz | 60f4e8b2ed | |
Christian Mäder | a51ad36801 | |
Christian Mäder | 953ee09b0c | |
Christian Mäder | 94047d60ed | |
Christian Mäder | 80bfd98000 | |
comphilip | 7694fd320a | |
Christian Mäder | 097bea8702 | |
comphilip | a3c21ae0ac | |
Christian Mäder | 074960327b | |
Christian Mäder | e1462d9ca4 | |
Christian Mäder | a5aa1bfd3b | |
Christian Mäder | cb02450783 | |
comphilip | 8307560c88 | |
Christian Mäder | 43aea3a1dd | |
Tobias Genannt | bb2ac7bd71 | |
Tobias Genannt | 30a98c5009 | |
Christian Mäder | a52a5547be | |
Tobias Genannt | 120a605d35 | |
Christian Mäder | e51f9cbc18 | |
Tobias Genannt | 071401b771 | |
Tobias Genannt | 911488242f | |
Christian Mäder | 5512ea68b3 | |
Christian Mäder | 7d055fbcaf | |
Tobias Genannt | 3d244a1946 | |
Christian Mäder | e18d6c53b3 | |
Christian Mäder | 48decdeb0e | |
Christian Mäder | 6ac65a64c9 | |
Christian Mäder | f46d8a7782 | |
Christian Mäder | 64d82b5e42 | |
Christian Mäder | 58050e5287 | |
Christian Mäder | 2dba2b8811 | |
Christian Mäder | d0c7b87925 | |
Christian Mäder | ec3fd8a790 | |
Christian Mäder | 75554ef5b4 | |
Christian Mäder | dad0608834 | |
Christian Mäder | dc77f1a0b1 | |
Christian Mäder | 16b567939c | |
Christian Mäder | 20820e10c2 | |
Christian Mäder | 553c8ea470 | |
Christian Mäder | 811618b359 | |
Christian Mäder | 7429835970 | |
Christian Mäder | 43c05d816d | |
Christian Mäder | fd3d3d11d1 | |
Christian Mäder | 121c3f800d | |
Christian Mäder | 9287995df4 | |
eemil | 85fbb0af70 | |
eemil | 6bada6660a | |
Christian Mäder | df3ab69c0f | |
Shuichiro MAKIGAKI | 38f4474b14 | |
Christian Mäder | 51331621ab | |
Christian Mäder | 156681f68d | |
Alex Houlton | 9f4a9f528c | |
Christian Mäder | cad803ed31 | |
Christian Mäder | 9efaccadf7 | |
Christian Mäder | f553d17655 | |
Christian Mäder | 2b361c4541 | |
Christian Mäder | c744603a85 | |
Eric Geldmacher | 1133ef50de | |
Tobias Genannt | b33a509e25 | |
Tobias Genannt | 79f0b997f3 | |
Tobias Genannt | 32cef1dcf8 | |
Tobias Genannt | 74833a9b21 | |
Tobias Genannt | a68f315acb | |
Tobias Genannt | 00022e7d79 | |
Tobias Genannt | dd490605ca | |
Tobias Genannt | e2711ca205 | |
Tobias Genannt | a87f2b3331 | |
tdorsey | f174749f98 | |
Tobias Genannt | b02a93904e | |
Tobias Genannt | 3ace32dfc2 | |
Tobias Genannt | 9fae2b0f74 | |
Christian Mäder | 23c3240863 | |
Jamie Reid | 3f9e874d77 | |
Christian Mäder | 4b0f158852 | |
John G | 51490d0039 | |
Aurélien Dunand | df72d6bbb5 | |
Christian Mäder | 688672de26 | |
Christian Mäder | 5624ecc65e | |
Christian Mäder | 7f93b328af | |
Christian Mäder | ccad15ecf7 | |
Tobias Genannt | e9a9d9b70b | |
Tobias Genannt | 03b36058cd | |
Tobias Genannt | 9e06a38d41 | |
Tobias Genannt | b7ad18afb0 | |
Aurélien Dunand | a9232e4f30 | |
Tobias Genannt | 93a3784295 | |
Tobias Genannt | 45f7823a17 | |
Tobias Genannt | a6584d2874 | |
Tobias Genannt | fd87c7cb98 | |
Christian Mäder | 1f38ca0a86 | |
Alexander GITTINGS | efec435ba0 | |
Alexander GITTINGS | ab8ff04852 | |
Christian Mäder | 77feec30a0 | |
mbchristoff | bed40b0d05 | |
Christian Mäder | 24f0545bc6 | |
Christian Mäder | 1bc1ab2a0a | |
Christian Mäder | bfa69dc0e9 | |
Christian Mäder | 6c8042b63d | |
Tobias Genannt | 795e82be46 | |
Tobias Genannt | d8a6c321a1 | |
ibeljakov | 1ecf4853b8 | |
Tobias Genannt | 5cb8e97e65 | |
Christian Mäder | 98e131fa30 | |
Hoanh An | d6323ce40f | |
ibeljakov | 1c65f7af10 | |
Tobias Genannt | 7fb78b3fd2 | |
Christian Mäder | aa9f01a778 | |
Tobias Genannt | 786f9b50d2 | |
Tobias Genannt | 5909670690 | |
Tobias Genannt | 231de236e0 | |
Christian Mäder | 9ea95950b9 | |
Tobias Genannt | d84c399c00 | |
Tobias Genannt | a217ce8ffd | |
Tobias Genannt | 794fb45e0e | |
Tobias Genannt | 8e34f46bad | |
Tobias Genannt | ed0d099df7 | |
Tobias Genannt | 26d08302e3 | |
Ryan Merolle | 64b763429f | |
Christian Mäder | 5769684c98 | |
Christian Mäder | 23e2da52f8 | |
Christian Mäder | edba1a22fc | |
nepeat | f87ffe7c33 | |
erin | 8bc77c1bc0 | |
Christian Mäder | 7662d81efe | |
Christian Mäder | 7f489aa11d | |
Tobias Genannt | 5c3eff0823 | |
Alexander GITTINGS | 5f90ad8c56 | |
Tobias Genannt | 5f1c241145 | |
Tobias Genannt | 20c7461c7b | |
Tobias Genannt | b9c44b85cc | |
Tobias Genannt | 355ebadd10 | |
Tobias Genannt | 880628876f | |
Tobias Genannt | 8d3bd48c7a | |
Tobias Genannt | 882f7bcaf2 | |
Tobias Genannt | 50ade7bce1 | |
Christian Mäder | 80f514fa90 | |
Christian Mäder | c5822b9cec | |
Christian Mäder | e99a222a70 | |
Christian Mäder | 3717b7469a | |
Christian Mäder | 3d80cc5a72 | |
Christian Mäder | 69ef7b7827 | |
Christian Mäder | ba3176f140 | |
Christian Mäder | a2c06026d5 | |
Les Begnaud | f4e243d5ad | |
Les Begnaud | aa0d2a6e01 | |
Les Begnaud | cce4370d41 | |
Les Begnaud | 927a545f41 | |
Christian Mäder | 0574ffc571 | |
Christian Mäder | ce74e94cbb | |
Christian Mäder | 778f7546b8 | |
Kevin Newland | 74eaae6bc8 | |
Kevin Newland | 00986573d9 | |
Christian Mäder | b0b20aa6ba | |
Christian Mäder | f3a858811a | |
Christian Mäder | 1eb40d1774 | |
Christian Mäder | 1f25fba671 | |
Christian Mäder | f525351cfe | |
Christian Mäder | 0e625a3b5c | |
Christian Mäder | f0b00ee104 | |
Christian Mäder | 1c8d695fc2 | |
Christian Mäder | 653321994a | |
Christian Mäder | 132ab6fcca | |
Christian Mäder | 9229b45dc2 |
|
@ -7,5 +7,4 @@ build*
|
||||||
docker-compose.override.yml
|
docker-compose.override.yml
|
||||||
.netbox/.git*
|
.netbox/.git*
|
||||||
.netbox/.travis.yml
|
.netbox/.travis.yml
|
||||||
.netbox/docs
|
|
||||||
.netbox/scripts
|
.netbox/scripts
|
||||||
|
|
|
@ -0,0 +1,23 @@
|
||||||
|
{
|
||||||
|
"Verbose": false,
|
||||||
|
"Debug": false,
|
||||||
|
"IgnoreDefaults": false,
|
||||||
|
"SpacesAftertabs": false,
|
||||||
|
"NoColor": false,
|
||||||
|
"Exclude": [
|
||||||
|
"LICENSE",
|
||||||
|
"\\.initializers",
|
||||||
|
"\\.vscode"
|
||||||
|
],
|
||||||
|
"AllowedContentTypes": [],
|
||||||
|
"PassedFiles": [],
|
||||||
|
"Disable": {
|
||||||
|
// set these options to true to disable specific checks
|
||||||
|
"EndOfLine": false,
|
||||||
|
"Indentation": false,
|
||||||
|
"InsertFinalNewline": false,
|
||||||
|
"TrimTrailingWhitespace": false,
|
||||||
|
"IndentSize": true,
|
||||||
|
"MaxLineLength": false
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,11 @@
|
||||||
|
root = true
|
||||||
|
|
||||||
|
[*]
|
||||||
|
end_of_line = lf
|
||||||
|
insert_final_newline = true
|
||||||
|
charset = utf-8
|
||||||
|
indent_style = space
|
||||||
|
indent_size = 2
|
||||||
|
|
||||||
|
[*.py]
|
||||||
|
indent_size = 4
|
|
@ -0,0 +1,7 @@
|
||||||
|
[flake8]
|
||||||
|
max-line-length = 100
|
||||||
|
extend-ignore = E203, W503
|
||||||
|
per-file-ignores =
|
||||||
|
configuration/*:E131,E251,E266,E302,E305,E501,E722
|
||||||
|
startup_scripts/startup_script_utils/__init__.py:F401
|
||||||
|
docker/*:E266,E722
|
|
@ -0,0 +1,14 @@
|
||||||
|
# These are supported funding model platforms
|
||||||
|
|
||||||
|
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
|
||||||
|
- cimnine
|
||||||
|
- tobiasge
|
||||||
|
patreon: # Replace with a single Patreon username
|
||||||
|
open_collective: # Replace with a single Open Collective username
|
||||||
|
ko_fi: # Replace with a single Ko-fi username
|
||||||
|
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||||
|
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||||
|
liberapay: # Replace with a single Liberapay username
|
||||||
|
issuehunt: # Replace with a single IssueHunt username
|
||||||
|
otechie: # Replace with a single Otechie username
|
||||||
|
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
|
@ -1,77 +0,0 @@
|
||||||
---
|
|
||||||
name: Bug report
|
|
||||||
about: Create a report to help us improve
|
|
||||||
title: ''
|
|
||||||
labels: ''
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<!--
|
|
||||||
|
|
||||||
Before raising an issue here, answer the following questions for yourself, please:
|
|
||||||
|
|
||||||
* Did you read through the troubleshooting section? (https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting)
|
|
||||||
* Have you had a look at the rest of the wiki? (https://github.com/netbox-community/netbox-docker/wiki)
|
|
||||||
* Have you updated to the latest version and tried again? (i.e. `git pull` and `docker-compose pull`)
|
|
||||||
* Have you reset the project and tried again? (i.e. `docker-compose down -v`)
|
|
||||||
* Are you confident that your problem is related to the Docker image or Docker Compose file this project provides?
|
|
||||||
(Otherwise ask on the Netbox mailing list, please: https://groups.google.com/d/forum/netbox-discuss)
|
|
||||||
* Have you looked through the issues already resolved?
|
|
||||||
|
|
||||||
Please try this means to get help before opening an issue here:
|
|
||||||
|
|
||||||
* On the networktocode Slack in the #netbox-docker channel: http://slack.networktocode.com/
|
|
||||||
* On the networktocode Slack in the #netbox channel: http://slack.networktocode.com/
|
|
||||||
* On the Netbox mailing list: https://groups.google.com/d/forum/netbox-discuss
|
|
||||||
|
|
||||||
Please don't open an issue when you have a PR ready. Just submit the PR, that's good enough.
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
## Current Behavior
|
|
||||||
|
|
||||||
<!-- describe what you did and how it misbehaved -->
|
|
||||||
...
|
|
||||||
|
|
||||||
## Expected Behavior
|
|
||||||
|
|
||||||
<!-- describe what you expected instead -->
|
|
||||||
...
|
|
||||||
|
|
||||||
## Debug Information
|
|
||||||
|
|
||||||
<!-- please fill in the following information that might helps us debug your problem more quickly -->
|
|
||||||
The output of `docker-compose version`: `XXXXX`
|
|
||||||
The output of `docker version`: `XXXXX`
|
|
||||||
The output of `git rev-parse HEAD`: `XXXXX`
|
|
||||||
The command you used to start the project: `XXXXX`
|
|
||||||
|
|
||||||
<!-- adjust the `latest` tag to the version you're using -->
|
|
||||||
The output of `docker inspect netboxcommunity/netbox:latest --format "{{json .ContainerConfig.Labels}}"`:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"JSON JSON JSON":
|
|
||||||
"--> Please paste formatted json. (Use e.g. `jq` or https://jsonformatter.curiousconcept.com/)"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
The output of `docker-compose logs netbox`:
|
|
||||||
<!--
|
|
||||||
If your log is very long, create a Gist instead (and post the link to it): https://gist.github.com
|
|
||||||
-->
|
|
||||||
|
|
||||||
```text
|
|
||||||
LOG LOG LOG
|
|
||||||
```
|
|
||||||
|
|
||||||
The output of `docker-compose logs nginx`:
|
|
||||||
<!--
|
|
||||||
Only if you have gotten a 5xx http error, else delete this section.
|
|
||||||
If your log is very long, create a Gist instead (and post the link to it): https://gist.github.com
|
|
||||||
-->
|
|
||||||
|
|
||||||
```text
|
|
||||||
LOG LOG LOG
|
|
||||||
```
|
|
|
@ -0,0 +1,148 @@
|
||||||
|
name: Bug report
|
||||||
|
description: Create a report about a malfunction of the Docker setup
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Please only raise an issue if you're certain that you've found a bug.
|
||||||
|
Else, see these other means to get help:
|
||||||
|
|
||||||
|
- See our troubleshooting section:
|
||||||
|
https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting
|
||||||
|
- Have a look at the rest of the wiki:
|
||||||
|
https://github.com/netbox-community/netbox-docker/wiki
|
||||||
|
- Check the release notes:
|
||||||
|
https://github.com/netbox-community/netbox-docker/releases
|
||||||
|
- Look through the issues already resolved:
|
||||||
|
https://github.com/netbox-community/netbox-docker/issues?q=is%3Aclosed
|
||||||
|
|
||||||
|
If you did not find what you're looking for,
|
||||||
|
try the help of our community:
|
||||||
|
|
||||||
|
- Post to Github Discussions:
|
||||||
|
https://github.com/netbox-community/netbox-docker/discussions
|
||||||
|
- Join the `#netbox-docker` channel on our Slack:
|
||||||
|
https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
|
||||||
|
- Ask on the NetBox mailing list:
|
||||||
|
https://groups.google.com/d/forum/netbox-discuss
|
||||||
|
|
||||||
|
Please don't open an issue to open a PR.
|
||||||
|
Just submit the PR, that's good enough.
|
||||||
|
- type: textarea
|
||||||
|
id: current-behavior
|
||||||
|
attributes:
|
||||||
|
label: Current Behavior
|
||||||
|
description: Please describe what you did and how you think it misbehaved
|
||||||
|
placeholder: I tried to … by doing …, but it …
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: expected-behavior
|
||||||
|
attributes:
|
||||||
|
label: Expected Behavior
|
||||||
|
description: Please describe what you expected instead
|
||||||
|
placeholder: I expected that … when I do …
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: docker-compose-version
|
||||||
|
attributes:
|
||||||
|
label: Docker Compose Version
|
||||||
|
description: Please paste the output of `docker-compose version`
|
||||||
|
placeholder: Docker Compose version vX.Y.Z
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: docker-version
|
||||||
|
attributes:
|
||||||
|
label: Docker Version
|
||||||
|
description: Please paste the output of `docker version`
|
||||||
|
render: text
|
||||||
|
placeholder: |
|
||||||
|
Client:
|
||||||
|
Cloud integration: 1.0.17
|
||||||
|
Version: 20.10.8
|
||||||
|
API version: 1.41
|
||||||
|
Go version: go1.16.6
|
||||||
|
Git commit: 3967b7d
|
||||||
|
Built: Fri Jul 30 19:55:20 2021
|
||||||
|
OS/Arch: darwin/amd64
|
||||||
|
Context: default
|
||||||
|
Experimental: true
|
||||||
|
|
||||||
|
Server: Docker Engine - Community
|
||||||
|
Engine:
|
||||||
|
Version: 20.10.8
|
||||||
|
API version: 1.41 (minimum version 1.12)
|
||||||
|
Go version: go1.16.6
|
||||||
|
Git commit: 75249d8
|
||||||
|
Built: Fri Jul 30 19:52:10 2021
|
||||||
|
OS/Arch: linux/amd64
|
||||||
|
Experimental: false
|
||||||
|
containerd:
|
||||||
|
Version: 1.4.9
|
||||||
|
GitCommit: e25210fe30a0a703442421b0f60afac609f950a3
|
||||||
|
runc:
|
||||||
|
Version: 1.0.1
|
||||||
|
GitCommit: v1.0.1-0-g4144b63
|
||||||
|
docker-init:
|
||||||
|
Version: 0.19.0
|
||||||
|
GitCommit: de40ad0
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: git-rev
|
||||||
|
attributes:
|
||||||
|
label: The git Revision
|
||||||
|
description: Please paste the output of `git rev-parse HEAD`
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: git-status
|
||||||
|
attributes:
|
||||||
|
label: The git Status
|
||||||
|
description: Please paste the output of `git status`
|
||||||
|
render: text
|
||||||
|
placeholder: |
|
||||||
|
On branch main
|
||||||
|
nothing to commit, working tree clean
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: run-command
|
||||||
|
attributes:
|
||||||
|
label: Startup Command
|
||||||
|
description: Please specify the command you used to start the project
|
||||||
|
placeholder: docker compose up
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: netbox-logs
|
||||||
|
attributes:
|
||||||
|
label: NetBox Logs
|
||||||
|
description: Please paste the output of `docker-compose logs netbox` (or `docker compose logs netbox`)
|
||||||
|
render: text
|
||||||
|
placeholder: |
|
||||||
|
netbox_1 | ⚙️ Applying database migrations
|
||||||
|
netbox_1 | 🧬 loaded config '/etc/netbox/config/configuration.py'
|
||||||
|
netbox_1 | 🧬 loaded config '/etc/netbox/config/a.py'
|
||||||
|
netbox_1 | 🧬 loaded config '/etc/netbox/config/extra.py'
|
||||||
|
netbox_1 | 🧬 loaded config '/etc/netbox/config/logging.py'
|
||||||
|
netbox_1 | 🧬 loaded config '/etc/netbox/config/plugins.py'
|
||||||
|
...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: docker-compose-override-yml
|
||||||
|
attributes:
|
||||||
|
label: Content of docker-compose.override.yml
|
||||||
|
description: Please paste the output of `cat docker-compose.override.yml`
|
||||||
|
render: yaml
|
||||||
|
placeholder: |
|
||||||
|
version: '3.4'
|
||||||
|
services:
|
||||||
|
netbox:
|
||||||
|
ports:
|
||||||
|
- '8080:8080'
|
||||||
|
validations:
|
||||||
|
required: true
|
|
@ -0,0 +1,15 @@
|
||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: Question
|
||||||
|
url: https://github.com/netbox-community/netbox-docker/discussions
|
||||||
|
about: The Github Discussions are the right place to ask questions about how to use or do certain things with NetBox Docker.
|
||||||
|
|
||||||
|
- name: Chat
|
||||||
|
url: https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
|
||||||
|
about: 'Usually the quickest way to seek help with small issues is to join our #netbox-docker Slack channel.'
|
||||||
|
|
||||||
|
- name: Community Wiki
|
||||||
|
url: https://github.com/netbox-community/netbox-docker/wiki
|
||||||
|
about: |
|
||||||
|
Our wiki contains information for common problems and tips for operating NetBox Docker in production.
|
||||||
|
It's maintained by our excellent community.
|
|
@ -1,54 +0,0 @@
|
||||||
---
|
|
||||||
name: Feature or Change Request
|
|
||||||
about: Request a new feature or a change of the current behavior
|
|
||||||
title: ''
|
|
||||||
labels: ''
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<!--
|
|
||||||
|
|
||||||
Before raising an issue here, answer the following questions for yourself, please:
|
|
||||||
|
|
||||||
* Did you read through the troubleshooting section? (https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting)
|
|
||||||
* Have you had a look at the rest of the wiki? (https://github.com/netbox-community/netbox-docker/wiki)
|
|
||||||
* Have you read the release notes recently (https://github.com/netbox-community/netbox-docker/releases)
|
|
||||||
* Are you confident that your feature/change request is related to the Docker image or Docker Compose file this project provides?
|
|
||||||
(Otherwise ask on the Netbox mailing list, please: https://groups.google.com/d/forum/netbox-discuss)
|
|
||||||
* Have you looked through the issues already resolved?
|
|
||||||
|
|
||||||
Please try this means to get help before opening an issue here:
|
|
||||||
|
|
||||||
* On the networktocode Slack in the #netbox-docker channel: http://slack.networktocode.com/
|
|
||||||
* On the networktocode Slack in the #netbox channel: http://slack.networktocode.com/
|
|
||||||
* On the Netbox mailing list: https://groups.google.com/d/forum/netbox-discuss
|
|
||||||
|
|
||||||
Please don't open an issue when you have a PR ready. Just submit the PR, that's good enough.
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
## Desired Behavior
|
|
||||||
|
|
||||||
<!-- please describe the behavior you desire -->
|
|
||||||
...
|
|
||||||
|
|
||||||
## Contrast to Current Behavior
|
|
||||||
|
|
||||||
<!-- please describe how the desired behavior is different from the current behavior -->
|
|
||||||
...
|
|
||||||
|
|
||||||
## Changes Required
|
|
||||||
|
|
||||||
<!-- if you can, please elaborate what changes would exactly be required -->
|
|
||||||
...
|
|
||||||
|
|
||||||
## Discussion: Benefits and Drawbacks
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Please make your case here:
|
|
||||||
- Why do you think this project and the community will benefit from your suggestion?
|
|
||||||
- What are the drawbacks of this change? Is it backwards-compatible?
|
|
||||||
- Anything else that you think is relevant to the discussion of this feature/change request.
|
|
||||||
-->
|
|
||||||
...
|
|
|
@ -0,0 +1,68 @@
|
||||||
|
name: Feature or Change Request
|
||||||
|
description: Request a new feature or a change of the current behavior
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
This issue type is to propose new features for the Docker setup.
|
||||||
|
To just spin an idea, see the Github Discussions section, please.
|
||||||
|
|
||||||
|
Before asking for help, see these links first:
|
||||||
|
|
||||||
|
- See our troubleshooting section:
|
||||||
|
https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting
|
||||||
|
- Have a look at the rest of the wiki:
|
||||||
|
https://github.com/netbox-community/netbox-docker/wiki
|
||||||
|
- Check the release notes:
|
||||||
|
https://github.com/netbox-community/netbox-docker/releases
|
||||||
|
- Look through the issues already resolved:
|
||||||
|
https://github.com/netbox-community/netbox-docker/issues?q=is%3Aclosed
|
||||||
|
|
||||||
|
If you did not find what you're looking for,
|
||||||
|
try the help of our community:
|
||||||
|
|
||||||
|
- Post to Github Discussions:
|
||||||
|
https://github.com/netbox-community/netbox-docker/discussions
|
||||||
|
- Join the `#netbox-docker` channel on our Slack:
|
||||||
|
https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
|
||||||
|
- Ask on the NetBox mailing list:
|
||||||
|
https://groups.google.com/d/forum/netbox-discuss
|
||||||
|
|
||||||
|
Please don't open an issue to open a PR.
|
||||||
|
Just submit the PR, that's good enough.
|
||||||
|
- type: textarea
|
||||||
|
id: desired-behavior
|
||||||
|
attributes:
|
||||||
|
label: Desired Behavior
|
||||||
|
description: Please describe the desired behavior
|
||||||
|
placeholder: To me, it would be useful, if … because …
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: contrast-to-current
|
||||||
|
attributes:
|
||||||
|
label: Contrast to Current Behavior
|
||||||
|
description: Please describe how the desired behavior is different from the current behavior
|
||||||
|
placeholder: The current behavior is …, but this lacks …
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: required-changes
|
||||||
|
attributes:
|
||||||
|
label: Required Changes
|
||||||
|
description: If you can, please elaborate what changes will be required to implement the desired behavior
|
||||||
|
placeholder: I suggest to change the file …
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: discussion
|
||||||
|
attributes:
|
||||||
|
label: 'Discussion: Benefits and Drawbacks'
|
||||||
|
description: |
|
||||||
|
Please make your case here:
|
||||||
|
- Why do you think this project and the community will benefit from your suggestion?
|
||||||
|
- What are the drawbacks of this change? Is it backwards-compatible?
|
||||||
|
- Anything else that you think is relevant to the discussion of this feature/change request.
|
||||||
|
placeholder: I suggest to change the file …
|
||||||
|
validations:
|
||||||
|
required: false
|
|
@ -0,0 +1,10 @@
|
||||||
|
# Configuration for probot-no-response - https://github.com/probot/no-response
|
||||||
|
|
||||||
|
# Number of days of inactivity before an Issue is closed for lack of response
|
||||||
|
daysUntilClose: 30
|
||||||
|
# Label requiring a response
|
||||||
|
responseRequiredLabel: awaiting answer
|
||||||
|
# Comment to post when closing an Issue for lack of response. Set to `false` to disable
|
||||||
|
closeComment: >
|
||||||
|
This issue has been automatically closed because there has been no response
|
||||||
|
to our request for more information from the original author.
|
|
@ -1,5 +1,5 @@
|
||||||
<!--
|
<!--
|
||||||
###############################################################################
|
#########################################################################
|
||||||
|
|
||||||
Thank you for sharing your work and for opening a PR.
|
Thank you for sharing your work and for opening a PR.
|
||||||
|
|
||||||
|
@ -9,11 +9,11 @@ First make sure that you point your PR to the `develop` branch!
|
||||||
Now please read the comments carefully and try to provide information
|
Now please read the comments carefully and try to provide information
|
||||||
on all relevant titles.
|
on all relevant titles.
|
||||||
|
|
||||||
###############################################################################
|
#########################################################################
|
||||||
-->
|
-->
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Please don't open an extra issue when submiting a PR.
|
Please don't open an extra issue when submitting a PR.
|
||||||
|
|
||||||
But if there is already a related issue, please put it's number here.
|
But if there is already a related issue, please put it's number here.
|
||||||
|
|
||||||
|
@ -81,5 +81,5 @@ Please put an x into the brackets (like `[x]`) if you've completed that task.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
* [ ] I have read the comments and followed the PR template.
|
* [ ] I have read the comments and followed the PR template.
|
||||||
* [ ] I have provided and explained my PR according to the information in the comments.
|
* [ ] I have explained my PR according to the information in the comments.
|
||||||
* [ ] My PR targets the `develop` branch.
|
* [ ] My PR targets the `develop` branch.
|
||||||
|
|
|
@ -1,35 +1,80 @@
|
||||||
|
---
|
||||||
|
name: push
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches-ignore:
|
branches-ignore:
|
||||||
- release
|
- release
|
||||||
|
pull_request:
|
||||||
|
branches-ignore:
|
||||||
|
- release
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
lint:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
name: Checks syntax of our code
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
# Full git history is needed to get a proper
|
||||||
|
# list of changed files within `super-linter`
|
||||||
|
fetch-depth: 0
|
||||||
|
- uses: actions/setup-python@v4
|
||||||
|
with:
|
||||||
|
python-version: '3.9'
|
||||||
|
- name: Lint Code Base
|
||||||
|
uses: github/super-linter@v4
|
||||||
|
env:
|
||||||
|
DEFAULT_BRANCH: develop
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
SUPPRESS_POSSUM: true
|
||||||
|
LINTER_RULES_PATH: /
|
||||||
|
VALIDATE_ALL_CODEBASE: false
|
||||||
|
VALIDATE_DOCKERFILE: false
|
||||||
|
VALIDATE_GITLEAKS: false
|
||||||
|
FILTER_REGEX_EXCLUDE: (.*/)?(LICENSE|configuration/.*)
|
||||||
|
EDITORCONFIG_FILE_NAME: .ecrc
|
||||||
|
DOCKERFILE_HADOLINT_FILE_NAME: .hadolint.yaml
|
||||||
|
MARKDOWN_CONFIG_FILE: .markdown-lint.yml
|
||||||
|
PYTHON_BLACK_CONFIG_FILE: pyproject.toml
|
||||||
|
PYTHON_FLAKE8_CONFIG_FILE: .flake8
|
||||||
|
PYTHON_ISORT_CONFIG_FILE: pyproject.toml
|
||||||
|
YAML_CONFIG_FILE: .yamllint.yaml
|
||||||
build:
|
build:
|
||||||
|
continue-on-error: ${{ matrix.build_cmd != './build-latest.sh' }}
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
build_cmd:
|
build_cmd:
|
||||||
- ./build-latest.sh
|
- ./build-latest.sh
|
||||||
- PRERELEASE=true ./build-latest.sh
|
- PRERELEASE=true ./build-latest.sh
|
||||||
- ./build-branches.sh
|
- ./build.sh feature
|
||||||
docker_from:
|
- ./build.sh develop
|
||||||
- '' # use the default of the DOCKERFILE
|
platform:
|
||||||
- python:3.7-alpine
|
- linux/amd64
|
||||||
- python:3.8-alpine
|
- linux/arm64
|
||||||
- python:3.9-rc-alpine
|
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
|
env:
|
||||||
|
GH_ACTION: enable
|
||||||
|
IMAGE_NAMES: docker.io/netboxcommunity/netbox
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
name: Builds new Netbox Docker Images
|
name: Builds new NetBox Docker Images
|
||||||
steps:
|
steps:
|
||||||
- id: git-checkout
|
- id: git-checkout
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v1
|
uses: actions/checkout@v3
|
||||||
- id: docker-build
|
- id: qemu-setup
|
||||||
name: Build the image from '${{ matrix.docker_from }}' with '${{ matrix.build_cmd }}'
|
name: Set up QEMU
|
||||||
run: ${{ matrix.build_cmd }}
|
uses: docker/setup-qemu-action@v2
|
||||||
env:
|
- id: buildx-setup
|
||||||
DOCKER_FROM: ${{ matrix.docker_from }}
|
name: Set up Docker Buildx
|
||||||
GH_ACTION: enable
|
uses: docker/setup-buildx-action@v2
|
||||||
- id: docker-test
|
- id: docker-build
|
||||||
name: Test the image
|
name: Build the image for '${{ matrix.platform }}' with '${{ matrix.build_cmd }}'
|
||||||
run: IMAGE="${FINAL_DOCKER_TAG}" ./test.sh
|
run: ${{ matrix.build_cmd }}
|
||||||
if: steps.docker-build.outputs.skipped != 'true'
|
env:
|
||||||
|
BUILDX_PLATFORM: ${{ matrix.platform }}
|
||||||
|
BUILDX_BUILDER_NAME: ${{ steps.buildx-setup.outputs.name }}
|
||||||
|
- id: docker-test
|
||||||
|
name: Test the image
|
||||||
|
run: IMAGE="${FINAL_DOCKER_TAG}" ./test.sh
|
||||||
|
if: steps.docker-build.outputs.skipped != 'true'
|
||||||
|
|
|
@ -1,49 +1,83 @@
|
||||||
|
---
|
||||||
|
name: release
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
release:
|
||||||
branches:
|
types:
|
||||||
- release
|
- published
|
||||||
schedule:
|
schedule:
|
||||||
- cron: '45 5 * * *'
|
- cron: '45 5 * * *'
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
build_cmd:
|
build_cmd:
|
||||||
- ./build-latest.sh
|
- ./build-latest.sh
|
||||||
- PRERELEASE=true ./build-latest.sh
|
- PRERELEASE=true ./build-latest.sh
|
||||||
- ./build-branches.sh
|
- ./build.sh feature
|
||||||
|
- ./build.sh develop
|
||||||
|
platform:
|
||||||
|
- linux/amd64,linux/arm64
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
name: Builds new Netbox Docker Images
|
name: Builds new NetBox Docker Images
|
||||||
|
env:
|
||||||
|
GH_ACTION: enable
|
||||||
|
IMAGE_NAMES: docker.io/netboxcommunity/netbox quay.io/netboxcommunity/netbox ghcr.io/netbox-community/netbox
|
||||||
steps:
|
steps:
|
||||||
- id: git-checkout
|
- id: source-checkout
|
||||||
name: Checkout
|
name: Checkout
|
||||||
uses: actions/checkout@v1
|
uses: actions/checkout@v3
|
||||||
- id: docker-build
|
- id: set-netbox-docker-version
|
||||||
name: Build the image with '${{ matrix.build_cmd }}'
|
name: Get Version of NetBox Docker
|
||||||
run: ${{ matrix.build_cmd }}
|
run: echo "::set-output name=version::$(cat VERSION)"
|
||||||
env:
|
shell: bash
|
||||||
GH_ACTION: enable
|
- id: qemu-setup
|
||||||
- id: docker-test
|
name: Set up QEMU
|
||||||
name: Test the image
|
uses: docker/setup-qemu-action@v2
|
||||||
run: IMAGE="${FINAL_DOCKER_TAG}" ./test.sh
|
- id: buildx-setup
|
||||||
if: steps.docker-build.outputs.skipped != 'true'
|
name: Set up Docker Buildx
|
||||||
- id: registry-login
|
uses: docker/setup-buildx-action@v2
|
||||||
name: Login to the Docker Registry
|
- id: docker-build
|
||||||
run: |
|
name: Build the image with '${{ matrix.build_cmd }}'
|
||||||
echo "::add-mask::$DOCKERHUB_USERNAME"
|
run: ${{ matrix.build_cmd }}
|
||||||
echo "::add-mask::$DOCKERHUB_PASSWORD"
|
- id: test-image
|
||||||
docker login -u "$DOCKERHUB_USERNAME" --password "${DOCKERHUB_PASSWORD}" "${DOCKER_REGISTRY}"
|
name: Test the image
|
||||||
env:
|
run: IMAGE="${FINAL_DOCKER_TAG}" ./test.sh
|
||||||
DOCKERHUB_USERNAME: ${{ secrets.dockerhub_username }}
|
if: steps.docker-build.outputs.skipped != 'true'
|
||||||
DOCKERHUB_PASSWORD: ${{ secrets.dockerhub_password }}
|
# docker.io
|
||||||
if: steps.docker-build.outputs.skipped != 'true'
|
- id: docker-io-login
|
||||||
- id: registry-push
|
name: Login to docker.io
|
||||||
name: Push the image
|
uses: docker/login-action@v2
|
||||||
run: ${{ matrix.build_cmd }} --push-only
|
with:
|
||||||
if: steps.docker-build.outputs.skipped != 'true'
|
registry: docker.io
|
||||||
- id: registry-logout
|
username: ${{ secrets.dockerhub_username }}
|
||||||
name: Logout of the Docker Registry
|
password: ${{ secrets.dockerhub_password }}
|
||||||
run: docker logout "${DOCKER_REGISTRY}"
|
if: steps.docker-build.outputs.skipped != 'true'
|
||||||
if: steps.docker-build.outputs.skipped != 'true'
|
# quay.io
|
||||||
|
- id: quay-io-login
|
||||||
|
name: Login to Quay.io
|
||||||
|
uses: docker/login-action@v2
|
||||||
|
with:
|
||||||
|
registry: quay.io
|
||||||
|
username: ${{ secrets.quayio_username }}
|
||||||
|
password: ${{ secrets.quayio_password }}
|
||||||
|
if: steps.docker-build.outputs.skipped != 'true'
|
||||||
|
# ghcr.io
|
||||||
|
- id: ghcr-io-login
|
||||||
|
name: Login to GitHub Container Registry
|
||||||
|
uses: docker/login-action@v2
|
||||||
|
with:
|
||||||
|
registry: ghcr.io
|
||||||
|
username: ${{ github.repository_owner }}
|
||||||
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
if: steps.docker-build.outputs.skipped != 'true'
|
||||||
|
- id: build-and-push
|
||||||
|
name: Push the image
|
||||||
|
run: ${{ matrix.build_cmd }} --push
|
||||||
|
if: steps.docker-build.outputs.skipped != 'true'
|
||||||
|
env:
|
||||||
|
BUILDX_PLATFORM: ${{ matrix.platform }}
|
||||||
|
BUILDX_BUILDER_NAME: ${{ steps.buildx-setup.outputs.name }}
|
||||||
|
|
|
@ -2,3 +2,14 @@
|
||||||
.netbox
|
.netbox
|
||||||
.initializers
|
.initializers
|
||||||
docker-compose.override.yml
|
docker-compose.override.yml
|
||||||
|
*.pem
|
||||||
|
configuration/*
|
||||||
|
!configuration/configuration.py
|
||||||
|
!configuration/extra.py
|
||||||
|
configuration/ldap/*
|
||||||
|
!configuration/ldap/extra.py
|
||||||
|
!configuration/ldap/ldap_config.py
|
||||||
|
!configuration/logging.py
|
||||||
|
!configuration/plugins.py
|
||||||
|
prometheus.yml
|
||||||
|
super-linter.log
|
||||||
|
|
|
@ -0,0 +1,4 @@
|
||||||
|
ignored:
|
||||||
|
- DL3006
|
||||||
|
- DL3008
|
||||||
|
- DL3003
|
|
@ -0,0 +1,2 @@
|
||||||
|
MD013: false
|
||||||
|
MD041: false
|
32
.travis.yml
32
.travis.yml
|
@ -1,32 +0,0 @@
|
||||||
sudo: required
|
|
||||||
language: python
|
|
||||||
|
|
||||||
env:
|
|
||||||
- BUILD=release
|
|
||||||
- BUILD=prerelease
|
|
||||||
- BUILD=branches
|
|
||||||
- BUILD=special
|
|
||||||
|
|
||||||
git:
|
|
||||||
depth: 5
|
|
||||||
|
|
||||||
services:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
install:
|
|
||||||
- docker-compose pull --parallel
|
|
||||||
- docker-compose build
|
|
||||||
|
|
||||||
script:
|
|
||||||
- docker-compose run netbox ./manage.py test
|
|
||||||
|
|
||||||
after_script:
|
|
||||||
- docker-compose down
|
|
||||||
|
|
||||||
after_success:
|
|
||||||
- docker login -u="$DOCKER_USERNAME" -p="$DOCKER_PASSWORD"
|
|
||||||
- ./build-all.sh --push
|
|
||||||
|
|
||||||
notifications:
|
|
||||||
slack:
|
|
||||||
secure: F3VsWcvU/XYyjGjU8ZAVGpREe7F1NjKq6LuMRzhQORbXUvanxDQtLzEe0Y5zm/6+gHkx6t8cX/v2PiCI+v46pkapYMUimd+QEOL1WxbUdnw2kQxcgw/R3wX34l2FHXbG3/a+TmH3euqbSCTIrPy9ufju948i+Q0E0u0fyInmozl8qOT23C4joQOpVAq7y+wHxTxsEg46ZzL2Ties+dmqjMsvHocv7mPI2IWzAWA8SJZxS82Amoapww++QjgEmoY+tMimLkdeXCRgeoj41UGHDg54rbEXh/PTaWiuzyzTr1WLmsGRScC57fDRivp3mSM37/MlNxsRj1z+j4zrvWFQgNfJ2yMjBHroc1jOX/uCY4dwbpSPqUCpc4idMGCGZFItgzTQ3lAPYAsom0C6n8C08Xk8EsNKWwXrDSd4ZUhIwptkNPCFK+kXbLFsMzSApnaBYW0T+wba57nZdiWjOPYmvJr49MDm5NHv2KaRBX2gpw7t7ZLhTgwGEWcZvcDebiLneXcXY5hZ7v2NHJkx/2x1yNXo85xZDy0wK1FGoOOHwPhvqOB+pcQZ/pUOSPTKqGw5l/CexoRm1shFsK+19FnSgimqTHjcuCo4lFW3JlEvlFhtfFXIte2Wjp1ALZgTrSq8zSD5rRxYCUKmM7b3EJwdaIgbvKWPdS4sCXlXU1bHx0g=
|
|
|
@ -0,0 +1,5 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
rules:
|
||||||
|
line-length:
|
||||||
|
max: 120
|
|
@ -1,63 +0,0 @@
|
||||||
# cloud.docker.com Configuration
|
|
||||||
|
|
||||||
The automatic build is configured in cloud.docker.com.
|
|
||||||
|
|
||||||
The following build configuration is expected:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Source Repository: github.com/netbox-community/netbox-docker
|
|
||||||
Build Location: Build on Docker Hub's infrastructure
|
|
||||||
Autotest: Internal and External Pull Requests
|
|
||||||
Repository Links: Enable for Base Image
|
|
||||||
Build Rules:
|
|
||||||
- Source Type: Branch
|
|
||||||
Source: release
|
|
||||||
Docker Tag: branches
|
|
||||||
Dockerfile location: Dockerfile
|
|
||||||
Build Context: /
|
|
||||||
Autobuild: on
|
|
||||||
Build Caching: on
|
|
||||||
- Source Type: Branch
|
|
||||||
Source: release
|
|
||||||
Docker Tag: prerelease
|
|
||||||
Dockerfile location: Dockerfile
|
|
||||||
Build Context: /
|
|
||||||
Autobuild: on
|
|
||||||
Build Caching: on
|
|
||||||
- Source Type: Branch
|
|
||||||
Source: release
|
|
||||||
Docker Tag: release
|
|
||||||
Dockerfile location: Dockerfile
|
|
||||||
Build Context: /
|
|
||||||
Autobuild: on
|
|
||||||
Build Caching: on
|
|
||||||
Build Environment Variables:
|
|
||||||
# Create an app on Github and use it's OATH credentials here
|
|
||||||
- Key: GITHUB_OAUTH_CLIENT_ID
|
|
||||||
Value: <secret>
|
|
||||||
- Key: GITHUB_OAUTH_CLIENT_SECRET
|
|
||||||
Value: <secret>
|
|
||||||
Build Triggers:
|
|
||||||
- Name: Cron Trigger
|
|
||||||
Trigger URL: <generated>
|
|
||||||
# Use this trigger in combination with e.g. https://cron-job.org in order to regularly schedule builds
|
|
||||||
```
|
|
||||||
|
|
||||||
## Background Knowledge
|
|
||||||
|
|
||||||
The build system of cloud.docker.com is not made for this kind of project.
|
|
||||||
But we found a way to make it work, and this is how:
|
|
||||||
|
|
||||||
1. The docker hub build system [allows to overwrite the scripts that get executed
|
|
||||||
for `build`, `test` and `push`](overwrite). See `/hooks/*`.
|
|
||||||
2. Shared functionality of the scripts `build`, `test` and `push` is extracted to `/hooks/common`.
|
|
||||||
3. The `build` script runs `run_build()` from `/hooks/common`.
|
|
||||||
This triggers either `/build-branches.sh`, `/build-latest.sh` or directly `/build.sh`.
|
|
||||||
4. The `test` script just invokes `docker-compose` commands.
|
|
||||||
5. The `push` script runs `run_build()` from `hooks/common` with a `--push-only` flag.
|
|
||||||
This causes the `build.sh` script to not re-build the Docker image, but just the just built image.
|
|
||||||
|
|
||||||
The _Docker Tag_ configuration setting (`$DOCKER_TAG`) is only used to select the type (_release_, _prerelease_, _branches_) of the build in `hooks/common`.
|
|
||||||
Because it has a different meaning in all the other build scripts, it is `unset` after it has served it's purpose.
|
|
||||||
|
|
||||||
[overwrite]: https://docs.docker.com/docker-hub/builds/advanced/#override-build-test-or-push-commands
|
|
164
Dockerfile
164
Dockerfile
|
@ -1,38 +1,40 @@
|
||||||
ARG FROM=python:3.7-alpine
|
ARG FROM
|
||||||
FROM ${FROM} as builder
|
FROM ${FROM} as builder
|
||||||
|
|
||||||
RUN apk add --no-cache \
|
RUN export DEBIAN_FRONTEND=noninteractive \
|
||||||
bash \
|
&& apt-get update -qq \
|
||||||
build-base \
|
&& apt-get upgrade \
|
||||||
|
--yes -qq --no-install-recommends \
|
||||||
|
&& apt-get install \
|
||||||
|
--yes -qq --no-install-recommends \
|
||||||
|
build-essential \
|
||||||
ca-certificates \
|
ca-certificates \
|
||||||
cyrus-sasl-dev \
|
libldap-dev \
|
||||||
graphviz \
|
libpq-dev \
|
||||||
jpeg-dev \
|
libsasl2-dev \
|
||||||
libevent-dev \
|
libssl-dev \
|
||||||
libffi-dev \
|
libxml2-dev \
|
||||||
|
libxml2-dev \
|
||||||
|
libxmlsec1 \
|
||||||
|
libxmlsec1-dev \
|
||||||
|
libxmlsec1-openssl \
|
||||||
libxslt-dev \
|
libxslt-dev \
|
||||||
openldap-dev \
|
pkg-config \
|
||||||
postgresql-dev
|
python3-dev \
|
||||||
|
python3-pip \
|
||||||
WORKDIR /install
|
python3-venv \
|
||||||
|
&& python3 -m venv /opt/netbox/venv \
|
||||||
RUN pip install --prefix="/install" --no-warn-script-location \
|
&& /opt/netbox/venv/bin/python3 -m pip install --upgrade \
|
||||||
# gunicorn is used for launching netbox
|
pip \
|
||||||
gunicorn \
|
setuptools \
|
||||||
greenlet \
|
wheel
|
||||||
eventlet \
|
|
||||||
# napalm is used for gathering information from network devices
|
|
||||||
napalm \
|
|
||||||
# ruamel is used in startup_scripts
|
|
||||||
'ruamel.yaml>=0.15,<0.16' \
|
|
||||||
# django_auth_ldap is required for ldap
|
|
||||||
django_auth_ldap \
|
|
||||||
# django-storages was introduced in 2.7 and is optional
|
|
||||||
django-storages
|
|
||||||
|
|
||||||
ARG NETBOX_PATH
|
ARG NETBOX_PATH
|
||||||
COPY ${NETBOX_PATH}/requirements.txt /
|
COPY ${NETBOX_PATH}/requirements.txt requirements-container.txt /
|
||||||
RUN pip install --prefix="/install" --no-warn-script-location -r /requirements.txt
|
RUN sed -i -e '/psycopg2-binary/d' requirements.txt && \
|
||||||
|
/opt/netbox/venv/bin/pip install \
|
||||||
|
-r /requirements.txt \
|
||||||
|
-r /requirements-container.txt
|
||||||
|
|
||||||
###
|
###
|
||||||
# Main stage
|
# Main stage
|
||||||
|
@ -41,66 +43,70 @@ RUN pip install --prefix="/install" --no-warn-script-location -r /requirements.t
|
||||||
ARG FROM
|
ARG FROM
|
||||||
FROM ${FROM} as main
|
FROM ${FROM} as main
|
||||||
|
|
||||||
RUN apk add --no-cache \
|
RUN export DEBIAN_FRONTEND=noninteractive \
|
||||||
bash \
|
&& apt-get update -qq \
|
||||||
|
&& apt-get upgrade \
|
||||||
|
--yes -qq --no-install-recommends \
|
||||||
|
&& apt-get install \
|
||||||
|
--yes -qq --no-install-recommends \
|
||||||
|
bzip2 \
|
||||||
ca-certificates \
|
ca-certificates \
|
||||||
graphviz \
|
curl \
|
||||||
libevent \
|
libldap-common \
|
||||||
libffi \
|
libpq5 \
|
||||||
libjpeg-turbo \
|
libxmlsec1-openssl \
|
||||||
libressl \
|
openssl \
|
||||||
libxslt \
|
python3 \
|
||||||
postgresql-libs \
|
python3-distutils \
|
||||||
ttf-ubuntu-font-family
|
tini \
|
||||||
|
&& curl -sL https://nginx.org/keys/nginx_signing.key \
|
||||||
|
> /etc/apt/trusted.gpg.d/nginx.asc && \
|
||||||
|
echo "deb https://packages.nginx.org/unit/ubuntu/ jammy unit" \
|
||||||
|
> /etc/apt/sources.list.d/unit.list \
|
||||||
|
&& apt-get update -qq \
|
||||||
|
&& apt-get install \
|
||||||
|
--yes -qq --no-install-recommends \
|
||||||
|
unit=1.27.0-1~jammy \
|
||||||
|
unit-python3.10=1.27.0-1~jammy \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
WORKDIR /opt
|
COPY --from=builder /opt/netbox/venv /opt/netbox/venv
|
||||||
|
|
||||||
COPY --from=builder /install /usr/local
|
|
||||||
|
|
||||||
ARG NETBOX_PATH
|
ARG NETBOX_PATH
|
||||||
COPY ${NETBOX_PATH} /opt/netbox
|
COPY ${NETBOX_PATH} /opt/netbox
|
||||||
|
|
||||||
COPY docker/configuration.docker.py /opt/netbox/netbox/netbox/configuration.py
|
COPY docker/configuration.docker.py /opt/netbox/netbox/netbox/configuration.py
|
||||||
COPY configuration/gunicorn_config.py /etc/netbox/config/
|
COPY docker/ldap_config.docker.py /opt/netbox/netbox/netbox/ldap_config.py
|
||||||
COPY docker/nginx.conf /etc/netbox-nginx/nginx.conf
|
|
||||||
COPY docker/docker-entrypoint.sh /opt/netbox/docker-entrypoint.sh
|
COPY docker/docker-entrypoint.sh /opt/netbox/docker-entrypoint.sh
|
||||||
COPY startup_scripts/ /opt/netbox/startup_scripts/
|
COPY docker/housekeeping.sh /opt/netbox/housekeeping.sh
|
||||||
COPY initializers/ /opt/netbox/initializers/
|
COPY docker/launch-netbox.sh /opt/netbox/launch-netbox.sh
|
||||||
COPY configuration/configuration.py /etc/netbox/config/configuration.py
|
COPY configuration/ /etc/netbox/config/
|
||||||
|
COPY docker/nginx-unit.json /etc/unit/
|
||||||
|
|
||||||
WORKDIR /opt/netbox/netbox
|
WORKDIR /opt/netbox/netbox
|
||||||
|
|
||||||
# Must set permissions for '/opt/netbox/netbox/static' directory
|
|
||||||
# to g+w so that `./manage.py collectstatic` can be executed during
|
|
||||||
# container startup.
|
|
||||||
# Must set permissions for '/opt/netbox/netbox/media' directory
|
# Must set permissions for '/opt/netbox/netbox/media' directory
|
||||||
# to g+w so that pictures can be uploaded to netbox.
|
# to g+w so that pictures can be uploaded to netbox.
|
||||||
RUN mkdir static && chmod g+w static media
|
RUN mkdir -p static /opt/unit/state/ /opt/unit/tmp/ \
|
||||||
|
&& chown -R unit:root media /opt/unit/ \
|
||||||
|
&& chmod -R g+w media /opt/unit/ \
|
||||||
|
&& cd /opt/netbox/ && SECRET_KEY="dummy" /opt/netbox/venv/bin/python -m mkdocs build \
|
||||||
|
--config-file /opt/netbox/mkdocs.yml --site-dir /opt/netbox/netbox/project-static/docs/ \
|
||||||
|
&& SECRET_KEY="dummy" /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py collectstatic --no-input
|
||||||
|
|
||||||
ENTRYPOINT [ "/opt/netbox/docker-entrypoint.sh" ]
|
ENV LANG=C.UTF-8 PATH=/opt/netbox/venv/bin:$PATH
|
||||||
|
ENTRYPOINT [ "/usr/bin/tini", "--" ]
|
||||||
|
|
||||||
CMD ["gunicorn", "-c /etc/netbox/config/gunicorn_config.py", "netbox.wsgi"]
|
CMD [ "/opt/netbox/docker-entrypoint.sh", "/opt/netbox/launch-netbox.sh" ]
|
||||||
|
|
||||||
LABEL ORIGINAL_TAG="" \
|
LABEL netbox.original-tag="" \
|
||||||
NETBOX_GIT_BRANCH="" \
|
netbox.git-branch="" \
|
||||||
NETBOX_GIT_REF="" \
|
netbox.git-ref="" \
|
||||||
NETBOX_GIT_URL="" \
|
netbox.git-url="" \
|
||||||
# See http://label-schema.org/rc1/#build-time-labels
|
|
||||||
# Also https://microbadger.com/labels
|
|
||||||
org.label-schema.schema-version="1.0" \
|
|
||||||
org.label-schema.build-date="" \
|
|
||||||
org.label-schema.name="Netbox Docker" \
|
|
||||||
org.label-schema.description="A container based distribution of Netbox, the free and open IPAM and DCIM solution." \
|
|
||||||
org.label-schema.vendor="The netbox-docker contributors." \
|
|
||||||
org.label-schema.url="https://github.com/netbox-community/netbox-docker" \
|
|
||||||
org.label-schema.usage="https://github.com/netbox-community/netbox-docker/wiki" \
|
|
||||||
org.label-schema.vcs-url="https://github.com/netbox-community/netbox-docker.git" \
|
|
||||||
org.label-schema.vcs-ref="" \
|
|
||||||
org.label-schema.version="snapshot" \
|
|
||||||
# See https://github.com/opencontainers/image-spec/blob/master/annotations.md#pre-defined-annotation-keys
|
# See https://github.com/opencontainers/image-spec/blob/master/annotations.md#pre-defined-annotation-keys
|
||||||
org.opencontainers.image.created="" \
|
org.opencontainers.image.created="" \
|
||||||
org.opencontainers.image.title="Netbox Docker" \
|
org.opencontainers.image.title="NetBox Docker" \
|
||||||
org.opencontainers.image.description="A container based distribution of Netbox, the free and open IPAM and DCIM solution." \
|
org.opencontainers.image.description="A container based distribution of NetBox, the free and open IPAM and DCIM solution." \
|
||||||
org.opencontainers.image.licenses="Apache-2.0" \
|
org.opencontainers.image.licenses="Apache-2.0" \
|
||||||
org.opencontainers.image.authors="The netbox-docker contributors." \
|
org.opencontainers.image.authors="The netbox-docker contributors." \
|
||||||
org.opencontainers.image.vendor="The netbox-docker contributors." \
|
org.opencontainers.image.vendor="The netbox-docker contributors." \
|
||||||
|
@ -108,18 +114,4 @@ LABEL ORIGINAL_TAG="" \
|
||||||
org.opencontainers.image.documentation="https://github.com/netbox-community/netbox-docker/wiki" \
|
org.opencontainers.image.documentation="https://github.com/netbox-community/netbox-docker/wiki" \
|
||||||
org.opencontainers.image.source="https://github.com/netbox-community/netbox-docker.git" \
|
org.opencontainers.image.source="https://github.com/netbox-community/netbox-docker.git" \
|
||||||
org.opencontainers.image.revision="" \
|
org.opencontainers.image.revision="" \
|
||||||
org.opencontainers.image.version="snapshot"
|
org.opencontainers.image.version=""
|
||||||
|
|
||||||
#####
|
|
||||||
## LDAP specific configuration
|
|
||||||
#####
|
|
||||||
|
|
||||||
FROM main as ldap
|
|
||||||
|
|
||||||
RUN apk add --no-cache \
|
|
||||||
libsasl \
|
|
||||||
libldap \
|
|
||||||
util-linux
|
|
||||||
|
|
||||||
COPY docker/ldap_config.docker.py /opt/netbox/netbox/netbox/ldap_config.py
|
|
||||||
COPY configuration/ldap_config.py /etc/netbox/config/ldap_config.py
|
|
||||||
|
|
190
README.md
190
README.md
|
@ -3,156 +3,156 @@
|
||||||
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/netbox-community/netbox-docker)][github-release]
|
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/netbox-community/netbox-docker)][github-release]
|
||||||
[![GitHub stars](https://img.shields.io/github/stars/netbox-community/netbox-docker)][github-stargazers]
|
[![GitHub stars](https://img.shields.io/github/stars/netbox-community/netbox-docker)][github-stargazers]
|
||||||
![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/netbox-community/netbox-docker)
|
![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/netbox-community/netbox-docker)
|
||||||
![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/netboxcommunity/netbox)
|
![Github release workflow](https://img.shields.io/github/workflow/status/netbox-community/netbox-docker/release)
|
||||||
![Docker Pulls](https://img.shields.io/docker/pulls/netboxcommunity/netbox)
|
![Docker Pulls](https://img.shields.io/docker/pulls/netboxcommunity/netbox)
|
||||||
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/netboxcommunity/netbox)][netbox-docker-microbadger]
|
|
||||||
[![MicroBadger Size](https://img.shields.io/microbadger/image-size/netboxcommunity/netbox)][netbox-docker-microbadger]
|
|
||||||
[![GitHub license](https://img.shields.io/github/license/netbox-community/netbox-docker)][netbox-docker-license]
|
[![GitHub license](https://img.shields.io/github/license/netbox-community/netbox-docker)][netbox-docker-license]
|
||||||
|
|
||||||
[The Github repository](netbox-docker-github) houses the components needed to build Netbox as a Docker container.
|
[The GitHub repository][netbox-docker-github] houses the components needed to build NetBox as a container.
|
||||||
Images are built using this code and are released to [Docker Hub][netbox-dockerhub] once a day.
|
Images are built regularly using the code in that repository and are pushed to [Docker Hub][netbox-dockerhub], [Quay.io][netbox-quayio] and [GitHub Container Registry][netbox-ghcr].
|
||||||
|
|
||||||
Do you have any questions? Before opening an issue on Github, please join the [Network To Code][ntc-slack] Slack and ask for help in our [`#netbox-docker`][netbox-docker-slack] channel.
|
Do you have any questions?
|
||||||
|
Before opening an issue on Github,
|
||||||
|
please join [our Slack][netbox-docker-slack] and ask for help in the [`#netbox-docker`][netbox-docker-slack-channel] channel.
|
||||||
|
|
||||||
[github-stargazers]: https://github.com/netbox-community/netbox-docker/stargazers
|
[github-stargazers]: https://github.com/netbox-community/netbox-docker/stargazers
|
||||||
[github-release]: https://github.com/netbox-community/netbox-docker/releases
|
[github-release]: https://github.com/netbox-community/netbox-docker/releases
|
||||||
[netbox-docker-microbadger]: https://microbadger.com/images/netboxcommunity/netbox
|
[netbox-dockerhub]: https://hub.docker.com/r/netboxcommunity/netbox/
|
||||||
[netbox-dockerhub]: https://hub.docker.com/r/netboxcommunity/netbox/tags/
|
[netbox-quayio]: https://quay.io/repository/netboxcommunity/netbox
|
||||||
|
[netbox-ghcr]: https://github.com/netbox-community/netbox-docker/pkgs/container/netbox
|
||||||
[netbox-docker-github]: https://github.com/netbox-community/netbox-docker/
|
[netbox-docker-github]: https://github.com/netbox-community/netbox-docker/
|
||||||
[ntc-slack]: http://slack.networktocode.com/
|
[netbox-docker-slack]: https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
|
||||||
[netbox-docker-slack]: https://slack.com/app_redirect?channel=netbox-docker&team=T09LQ7E9E
|
[netbox-docker-slack-channel]: https://netdev-community.slack.com/archives/C01P0GEVBU7
|
||||||
[netbox-docker-license]: https://github.com/netbox-community/netbox-docker/blob/master/LICENSE
|
[netbox-slack-channel]: https://netdev-community.slack.com/archives/C01P0FRSXRV
|
||||||
|
[netbox-docker-license]: https://github.com/netbox-community/netbox-docker/blob/release/LICENSE
|
||||||
## Docker Tags
|
|
||||||
|
|
||||||
* `vX.Y.Z`: Release builds, built from [releases of Netbox][netbox-releases].
|
|
||||||
* `latest`: Release builds, built from [`master` branch of Netbox][netbox-master].
|
|
||||||
* `snapshot`: Pre-release builds, built from the [`develop` branch of Netbox][netbox-develop].
|
|
||||||
* `develop-X.Y`: Pre-release builds, built from the corresponding [branch of Netbox][netbox-branches].
|
|
||||||
|
|
||||||
Then there is currently one extra tags for each of the above labels:
|
|
||||||
|
|
||||||
* `-ldap`: Contains additional dependencies and configurations for connecting Netbox to an LDAP directroy.
|
|
||||||
[Learn more about that in our wiki][netbox-docker-ldap].
|
|
||||||
|
|
||||||
[netbox-releases]: https://github.com/netbox-community/netbox/releases
|
|
||||||
[netbox-master]: https://github.com/netbox-community/netbox/tree/master
|
|
||||||
[netbox-develop]: https://github.com/netbox-community/netbox/tree/develop
|
|
||||||
[netbox-branches]: https://github.com/netbox-community/netbox/branches
|
|
||||||
[netbox-docker-ldap]: https://github.com/netbox-community/netbox-docker/wiki/LDAP
|
|
||||||
|
|
||||||
## Quickstart
|
## Quickstart
|
||||||
|
|
||||||
To get Netbox up and running in Docker:
|
To get _NetBox Docker_ up and running run the following commands.
|
||||||
|
There is a more complete [_Getting Started_ guide on our wiki][wiki-getting-started] which explains every step.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone -b release https://github.com/netbox-community/netbox-docker.git
|
git clone -b release https://github.com/netbox-community/netbox-docker.git
|
||||||
cd netbox-docker
|
cd netbox-docker
|
||||||
|
tee docker-compose.override.yml <<EOF
|
||||||
|
version: '3.4'
|
||||||
|
services:
|
||||||
|
netbox:
|
||||||
|
ports:
|
||||||
|
- 8000:8080
|
||||||
|
EOF
|
||||||
docker-compose pull
|
docker-compose pull
|
||||||
docker-compose up -d
|
docker-compose up
|
||||||
```
|
```
|
||||||
|
|
||||||
The application will be available after a few minutes.
|
The whole application will be available after a few minutes.
|
||||||
Use `docker-compose port nginx 8080` to find out where to connect to.
|
Open the URL `http://0.0.0.0:8000/` in a web-browser.
|
||||||
|
You should see the NetBox homepage.
|
||||||
```bash
|
In the top-right corner you can login.
|
||||||
$ echo "http://$(docker-compose port nginx 8080)/"
|
|
||||||
http://0.0.0.0:32768/
|
|
||||||
|
|
||||||
# Open netbox in your default browser on macOS:
|
|
||||||
$ open "http://$(docker-compose port nginx 8080)/"
|
|
||||||
|
|
||||||
# Open netbox in your default browser on (most) linuxes:
|
|
||||||
$ xdg-open "http://$(docker-compose port nginx 8080)/" &>/dev/null &
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively, use something like [Reception][docker-reception] to connect to _docker-compose_ projects.
|
|
||||||
|
|
||||||
The default credentials are:
|
The default credentials are:
|
||||||
|
|
||||||
* Username: **admin**
|
* Username: **admin**
|
||||||
* Password: **admin**
|
* Password: **admin**
|
||||||
* API Token: **0123456789abcdef0123456789abcdef01234567**
|
* API Token: **0123456789abcdef0123456789abcdef01234567**
|
||||||
|
|
||||||
There is a more complete [Getting Started guide on our Wiki][wiki-getting-started].
|
|
||||||
|
|
||||||
[wiki-getting-started]: https://github.com/netbox-community/netbox-docker/wiki/Getting-Started
|
[wiki-getting-started]: https://github.com/netbox-community/netbox-docker/wiki/Getting-Started
|
||||||
[docker-reception]: https://github.com/nxt-engineering/reception
|
|
||||||
|
|
||||||
## Dependencies
|
## Container Image Tags
|
||||||
|
|
||||||
This project relies only on *Docker* and *docker-compose* meeting these requirements:
|
New container images are built and published automatically every ~24h.
|
||||||
|
|
||||||
* The *Docker version* must be at least `17.05`.
|
> We recommend to use either the `vX.Y.Z-a.b.c` tags or the `vX.Y-a.b.c` tags in production!
|
||||||
* The *docker-compose version* must be at least `1.17.0`.
|
|
||||||
|
|
||||||
To check the version installed on your system run `docker --version` and `docker-compose --version`.
|
* `vX.Y.Z-a.b.c`, `vX.Y-a.b.c`:
|
||||||
|
These are release builds containing _NetBox version_ `vX.Y.Z`.
|
||||||
|
They contain the support files of _NetBox Docker version_ `a.b.c`.
|
||||||
|
You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
|
||||||
|
These images are automatically built from [the corresponding releases of NetBox][netbox-releases].
|
||||||
|
* `latest-a.b.c`:
|
||||||
|
These are release builds, containing the latest stable version of NetBox.
|
||||||
|
They contain the support files of _NetBox Docker version_ `a.b.c`.
|
||||||
|
You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
|
||||||
|
These images are automatically built from [the `master` branch of NetBox][netbox-master].
|
||||||
|
* `snapshot-a.b.c`:
|
||||||
|
These are prerelease builds.
|
||||||
|
They contain the support files of _NetBox Docker version_ `a.b.c`.
|
||||||
|
You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
|
||||||
|
These images are automatically built from the [`develop` branch of NetBox][netbox-develop].
|
||||||
|
|
||||||
|
For each of the above tag, there is an extra tag:
|
||||||
|
|
||||||
|
* `vX.Y.Z`, `vX.Y`:
|
||||||
|
This is the same version as `vX.Y.Z-a.b.c` (or `vX.Y-a.b.c`, respectively).
|
||||||
|
It always points to the latest version of _NetBox Docker_.
|
||||||
|
* `latest`
|
||||||
|
This is the same version as `latest-a.b.c`.
|
||||||
|
It always points to the latest version of _NetBox Docker_.
|
||||||
|
* `snapshot`
|
||||||
|
This is the same version as `snapshot-a.b.c`.
|
||||||
|
It always points to the latest version of _NetBox Docker_.
|
||||||
|
|
||||||
|
[netbox-releases]: https://github.com/netbox-community/netbox/releases
|
||||||
|
[netbox-master]: https://github.com/netbox-community/netbox/tree/master
|
||||||
|
[netbox-develop]: https://github.com/netbox-community/netbox/tree/develop
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
Please refer [to our wiki on Github][netbox-docker-wiki] for further information on how to use this Netbox Docker image properly.
|
Please refer [to our wiki on GitHub][netbox-docker-wiki] for further information on how to use the NetBox Docker image properly.
|
||||||
It covers advanced topics such as using secret files, deployment to Kubernetes as well as NAPALM and LDAP configuration.
|
The wiki covers advanced topics such as using files for secrets, configuring TLS, deployment to Kubernetes, monitoring and configuring NAPALM and LDAP.
|
||||||
|
|
||||||
|
Our wiki is a community effort.
|
||||||
|
Feel free to correct errors, update outdated information or provide additional guides and insights.
|
||||||
|
|
||||||
[netbox-docker-wiki]: https://github.com/netbox-community/netbox-docker/wiki/
|
[netbox-docker-wiki]: https://github.com/netbox-community/netbox-docker/wiki/
|
||||||
|
|
||||||
## Netbox Version
|
## Getting Help
|
||||||
|
|
||||||
The `docker-compose.yml` file is prepared to run a specific version of Netbox.
|
Feel free to ask questions in our [GitHub Community][netbox-community]
|
||||||
To use this feature, set the environment-variable `VERSION` before launching `docker-compose`, as shown below.
|
or [join our Slack][netbox-docker-slack] and ask [in our channel `#netbox-docker`][netbox-docker-slack-channel],
|
||||||
`VERSION` may be set to the name of
|
which is free to use and where there are almost always people online that can help you in the Slack channel.
|
||||||
[any tag of the `netboxcommunity/netbox` Docker image on Docker Hub][netbox-dockerhub].
|
|
||||||
|
|
||||||
```bash
|
If you need help with using NetBox or developing for it or against it's API
|
||||||
export VERSION=v2.7.1
|
you may find [the `#netbox` channel][netbox-slack-channel] on the same Slack instance very helpful.
|
||||||
docker-compose pull netbox
|
|
||||||
docker-compose up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also build a specific version of the Netbox Docker image yourself.
|
[netbox-community]: https://github.com/netbox-community/netbox-docker/discussions
|
||||||
`VERSION` can be any valid [git ref][git-ref] in that case.
|
|
||||||
|
|
||||||
```bash
|
## Dependencies
|
||||||
export VERSION=v2.7.1
|
|
||||||
./build.sh $VERSION
|
|
||||||
docker-compose up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
[git-ref]: https://git-scm.com/book/en/v2/Git-Internals-Git-References
|
This project relies only on _Docker_ and _docker-compose_ meeting these requirements:
|
||||||
[netbox-github]: https://github.com/netbox-community/netbox/releases
|
|
||||||
|
|
||||||
## Breaking Changes
|
* The _Docker version_ must be at least `20.10.10`.
|
||||||
|
* The _containerd version_ must be at least `1.5.6`.
|
||||||
|
* The _docker-compose version_ must be at least `1.28.0`.
|
||||||
|
|
||||||
From time to time it might become necessary to re-engineer the structure of this setup.
|
To check the version installed on your system run `docker --version` and `docker-compose --version`.
|
||||||
Things like the `docker-compose.yml` file or your Kubernetes or OpenShift configurations have to be adjusted as a consequence.
|
|
||||||
Since November 2019 each image built from this repo contains a `org.opencontainers.image.version` label.
|
## Updating
|
||||||
(The images contained labels since April 2018, although in November 2019 the labels' names changed.)
|
|
||||||
You can check the label of your local image by running `docker inspect netboxcommunity/netbox:v2.7.1 --format "{{json .ContainerConfig.Labels}}"`.
|
|
||||||
|
|
||||||
Please read [the release notes][releases] carefully when updating to a new image version.
|
Please read [the release notes][releases] carefully when updating to a new image version.
|
||||||
|
Note that the version of the NetBox Docker container image must stay in sync with the code.
|
||||||
|
|
||||||
|
If you update for the first time, be sure [to follow our _How To Update NetBox Docker_ guide in the wiki][netbox-docker-wiki-updating].
|
||||||
|
|
||||||
[releases]: https://github.com/netbox-community/netbox-docker/releases
|
[releases]: https://github.com/netbox-community/netbox-docker/releases
|
||||||
|
[netbox-docker-wiki-updating]: https://github.com/netbox-community/netbox-docker/wiki/Updating
|
||||||
|
|
||||||
## Rebuilding & Publishing images
|
## Rebuilding the Image
|
||||||
|
|
||||||
`./build.sh` can be used to rebuild the Docker image. See `./build.sh --help` for more information.
|
`./build.sh` can be used to rebuild the container image. See `./build.sh --help` for more information.
|
||||||
|
|
||||||
### Publishing Docker Images
|
For more details on custom builds [consult our wiki][netbox-docker-wiki-build].
|
||||||
|
|
||||||
New Docker images are built and published every 24h on the [Docker Build Infrastructure][docker-build-infra].
|
[netbox-docker-wiki-build]: https://github.com/netbox-community/netbox-docker/wiki/Build
|
||||||
`DOCKER_HUB.md` contains more information about the build infrastructure.
|
|
||||||
|
|
||||||
[docker-build-infra]: https://hub.docker.com/r/netboxcommunity/netbox/builds/
|
|
||||||
|
|
||||||
## Tests
|
## Tests
|
||||||
|
|
||||||
To run the tests coming with Netbox, use the `docker-compose.yml` file as such:
|
We have a test script.
|
||||||
|
It runs NetBox's own unit tests and ensures that all initializers work:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker-compose run netbox ./manage.py test
|
IMAGE=netboxcommunity/netbox:latest ./test.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
## About
|
## Support
|
||||||
|
|
||||||
This repository is currently maintained and funded by [nxt][nxt].
|
This repository is currently maintained by the community.
|
||||||
|
Please consider sponsoring the maintainers of this project.
|
||||||
[nxt]: https://nxt.engineering/en/
|
|
||||||
|
|
51
build-all.sh
51
build-all.sh
|
@ -1,51 +0,0 @@
|
||||||
#!/bin/bash
|
|
||||||
# Builds all Docker images this project provides
|
|
||||||
# Arguments:
|
|
||||||
# BUILD: The release to build.
|
|
||||||
# Allowed: release, prerelease, branches, special
|
|
||||||
# Default: undefined
|
|
||||||
|
|
||||||
echo "▶️ $0 $*"
|
|
||||||
|
|
||||||
ALL_BUILDS=("release" "prerelease" "branches" "special")
|
|
||||||
BUILDS=("${BUILD:-"${ALL_BUILDS[@]}"}")
|
|
||||||
|
|
||||||
echo "⚙️ Configured builds: ${BUILDS[*]}"
|
|
||||||
|
|
||||||
if [ -n "${DEBUG}" ]; then
|
|
||||||
export DEBUG
|
|
||||||
fi
|
|
||||||
|
|
||||||
ERROR=0
|
|
||||||
|
|
||||||
for BUILD in "${BUILDS[@]}"; do
|
|
||||||
echo "🛠 Building '$BUILD' from '$DOCKERFILE'"
|
|
||||||
case $BUILD in
|
|
||||||
release)
|
|
||||||
# build the latest release
|
|
||||||
# shellcheck disable=SC2068
|
|
||||||
./build-latest.sh $@ || ERROR=1
|
|
||||||
;;
|
|
||||||
prerelease)
|
|
||||||
# build the latest pre-release
|
|
||||||
# shellcheck disable=SC2068
|
|
||||||
PRERELEASE=true ./build-latest.sh $@ || ERROR=1
|
|
||||||
;;
|
|
||||||
branches)
|
|
||||||
# build all branches
|
|
||||||
# shellcheck disable=SC2068
|
|
||||||
./build-branches.sh $@ || ERROR=1
|
|
||||||
;;
|
|
||||||
*)
|
|
||||||
echo "🚨 Unrecognized build '$BUILD'."
|
|
||||||
|
|
||||||
if [ -z "$DEBUG" ]; then
|
|
||||||
exit 1
|
|
||||||
else
|
|
||||||
echo "⚠️ Would exit here with code '1', but DEBUG is enabled."
|
|
||||||
fi
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
|
|
||||||
exit $ERROR
|
|
|
@ -1,47 +0,0 @@
|
||||||
#!/bin/bash
|
|
||||||
# Builds develop, develop-* and master branches of Netbox
|
|
||||||
|
|
||||||
echo "▶️ $0 $*"
|
|
||||||
|
|
||||||
###
|
|
||||||
# Checking for the presence of GITHUB_OAUTH_CLIENT_ID
|
|
||||||
# and GITHUB_OAUTH_CLIENT_SECRET
|
|
||||||
###
|
|
||||||
if [ -n "${GITHUB_OAUTH_CLIENT_ID}" ] && [ -n "${GITHUB_OAUTH_CLIENT_SECRET}" ]; then
|
|
||||||
echo "🗝 Performing authenticated Github API calls."
|
|
||||||
GITHUB_OAUTH_PARAMS="client_id=${GITHUB_OAUTH_CLIENT_ID}&client_secret=${GITHUB_OAUTH_CLIENT_SECRET}"
|
|
||||||
else
|
|
||||||
echo "🕶 Performing unauthenticated Github API calls. This might result in lower Github rate limits!"
|
|
||||||
GITHUB_OAUTH_PARAMS=""
|
|
||||||
fi
|
|
||||||
|
|
||||||
###
|
|
||||||
# Calling Github to get the all branches
|
|
||||||
###
|
|
||||||
ORIGINAL_GITHUB_REPO="${SRC_ORG-netbox-community}/${SRC_REPO-netbox}"
|
|
||||||
GITHUB_REPO="${GITHUB_REPO-$ORIGINAL_GITHUB_REPO}"
|
|
||||||
URL_RELEASES="https://api.github.com/repos/${GITHUB_REPO}/branches?${GITHUB_OAUTH_PARAMS}"
|
|
||||||
|
|
||||||
# Composing the JQ commans to extract the most recent version number
|
|
||||||
JQ_BRANCHES='map(.name) | .[] | scan("^[^v].+") | match("^(master|develop).*") | .string'
|
|
||||||
|
|
||||||
CURL="curl -sS"
|
|
||||||
|
|
||||||
# Querying the Github API to fetch all branches
|
|
||||||
BRANCHES=$($CURL "${URL_RELEASES}" | jq -r "$JQ_BRANCHES")
|
|
||||||
|
|
||||||
###
|
|
||||||
# Building each branch
|
|
||||||
###
|
|
||||||
|
|
||||||
# keeping track whether an error occured
|
|
||||||
ERROR=0
|
|
||||||
|
|
||||||
# calling build.sh for each branch
|
|
||||||
for BRANCH in $BRANCHES; do
|
|
||||||
# shellcheck disable=SC2068
|
|
||||||
./build.sh "${BRANCH}" $@ || ERROR=1
|
|
||||||
done
|
|
||||||
|
|
||||||
# returning whether an error occured
|
|
||||||
exit $ERROR
|
|
|
@ -0,0 +1,82 @@
|
||||||
|
#!/bin/bash
|
||||||
|
# Retrieves image configuration from public images in DockerHub
|
||||||
|
# Functions from https://gist.github.com/cirocosta/17ea17be7ac11594cb0f290b0a3ac0d1
|
||||||
|
# Optimised for our use case
|
||||||
|
|
||||||
|
get_image_label() {
|
||||||
|
local label=$1
|
||||||
|
local image=$2
|
||||||
|
local tag=$3
|
||||||
|
local token
|
||||||
|
token=$(_get_token "$image")
|
||||||
|
local digest
|
||||||
|
digest=$(_get_digest "$image" "$tag" "$token")
|
||||||
|
local retval="null"
|
||||||
|
if [ "$digest" != "null" ]; then
|
||||||
|
retval=$(_get_image_configuration "$image" "$token" "$digest" "$label")
|
||||||
|
fi
|
||||||
|
echo "$retval"
|
||||||
|
}
|
||||||
|
|
||||||
|
get_image_layers() {
|
||||||
|
local image=$1
|
||||||
|
local tag=$2
|
||||||
|
local token
|
||||||
|
token=$(_get_token "$image")
|
||||||
|
_get_layers "$image" "$tag" "$token"
|
||||||
|
}
|
||||||
|
|
||||||
|
get_image_last_layer() {
|
||||||
|
local image=$1
|
||||||
|
local tag=$2
|
||||||
|
local token
|
||||||
|
token=$(_get_token "$image")
|
||||||
|
local layers
|
||||||
|
mapfile -t layers < <(_get_layers "$image" "$tag" "$token")
|
||||||
|
echo "${layers[-1]}"
|
||||||
|
}
|
||||||
|
|
||||||
|
_get_image_configuration() {
|
||||||
|
local image=$1
|
||||||
|
local token=$2
|
||||||
|
local digest=$3
|
||||||
|
local label=$4
|
||||||
|
curl \
|
||||||
|
--silent \
|
||||||
|
--location \
|
||||||
|
--header "Authorization: Bearer $token" \
|
||||||
|
"https://registry-1.docker.io/v2/$image/blobs/$digest" |
|
||||||
|
jq -r ".config.Labels.\"$label\""
|
||||||
|
}
|
||||||
|
|
||||||
|
_get_token() {
|
||||||
|
local image=$1
|
||||||
|
curl \
|
||||||
|
--silent \
|
||||||
|
"https://auth.docker.io/token?scope=repository:$image:pull&service=registry.docker.io" |
|
||||||
|
jq -r '.token'
|
||||||
|
}
|
||||||
|
|
||||||
|
_get_digest() {
|
||||||
|
local image=$1
|
||||||
|
local tag=$2
|
||||||
|
local token=$3
|
||||||
|
curl \
|
||||||
|
--silent \
|
||||||
|
--header "Accept: application/vnd.docker.distribution.manifest.v2+json" \
|
||||||
|
--header "Authorization: Bearer $token" \
|
||||||
|
"https://registry-1.docker.io/v2/$image/manifests/$tag" |
|
||||||
|
jq -r '.config.digest'
|
||||||
|
}
|
||||||
|
|
||||||
|
_get_layers() {
|
||||||
|
local image=$1
|
||||||
|
local tag=$2
|
||||||
|
local token=$3
|
||||||
|
curl \
|
||||||
|
--silent \
|
||||||
|
--header "Accept: application/vnd.docker.distribution.manifest.v2+json" \
|
||||||
|
--header "Authorization: Bearer $token" \
|
||||||
|
"https://registry-1.docker.io/v2/$image/manifests/$tag" |
|
||||||
|
jq -r '.layers[].digest'
|
||||||
|
}
|
|
@ -0,0 +1,21 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
###
|
||||||
|
# A regular echo, that only prints if ${GH_ACTION} is defined.
|
||||||
|
###
|
||||||
|
gh_echo() {
|
||||||
|
if [ -n "${GH_ACTION}" ]; then
|
||||||
|
echo "${@}"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
###
|
||||||
|
# Prints the output to the file defined in ${GITHUB_ENV}.
|
||||||
|
# Only executes if ${GH_ACTION} is defined.
|
||||||
|
# Example Usage: gh_env "FOO_VAR=bar_value"
|
||||||
|
###
|
||||||
|
gh_env() {
|
||||||
|
if [ -n "${GH_ACTION}" ]; then
|
||||||
|
echo "${@}" >>"${GITHUB_ENV}"
|
||||||
|
fi
|
||||||
|
}
|
|
@ -3,6 +3,14 @@
|
||||||
|
|
||||||
echo "▶️ $0 $*"
|
echo "▶️ $0 $*"
|
||||||
|
|
||||||
|
###
|
||||||
|
# Check for the jq library needed for parsing JSON
|
||||||
|
###
|
||||||
|
if ! command -v jq; then
|
||||||
|
echo "⚠️ jq command missing from \$PATH!"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
###
|
###
|
||||||
# Checking for the presence of GITHUB_OAUTH_CLIENT_ID
|
# Checking for the presence of GITHUB_OAUTH_CLIENT_ID
|
||||||
# and GITHUB_OAUTH_CLIENT_SECRET
|
# and GITHUB_OAUTH_CLIENT_SECRET
|
||||||
|
@ -19,7 +27,7 @@ fi
|
||||||
# Checking if PRERELEASE is either unset, 'true' or 'false'
|
# Checking if PRERELEASE is either unset, 'true' or 'false'
|
||||||
###
|
###
|
||||||
if [ -n "${PRERELEASE}" ] &&
|
if [ -n "${PRERELEASE}" ] &&
|
||||||
{ [ "${PRERELEASE}" != "true" ] && [ "${PRERELEASE}" != "false" ]; }; then
|
{ [ "${PRERELEASE}" != "true" ] && [ "${PRERELEASE}" != "false" ]; }; then
|
||||||
|
|
||||||
if [ -z "${DEBUG}" ]; then
|
if [ -z "${DEBUG}" ]; then
|
||||||
echo "⚠️ PRERELEASE must be either unset, 'true' or 'false', but was '${PRERELEASE}'!"
|
echo "⚠️ PRERELEASE must be either unset, 'true' or 'false', but was '${PRERELEASE}'!"
|
||||||
|
@ -60,9 +68,10 @@ if [ "${PRERELEASE}" == "true" ]; then
|
||||||
# shellcheck disable=SC2003
|
# shellcheck disable=SC2003
|
||||||
MINOR_UNSTABLE=$(expr match "${VERSION}" 'v[0-9]\+\.\([0-9]\+\)')
|
MINOR_UNSTABLE=$(expr match "${VERSION}" 'v[0-9]\+\.\([0-9]\+\)')
|
||||||
|
|
||||||
if { [ "${MAJOR_STABLE}" -eq "${MAJOR_UNSTABLE}" ] \
|
if {
|
||||||
&& [ "${MINOR_STABLE}" -ge "${MINOR_UNSTABLE}" ];
|
[ "${MAJOR_STABLE}" -eq "${MAJOR_UNSTABLE}" ] &&
|
||||||
} || [ "${MAJOR_STABLE}" -gt "${MAJOR_UNSTABLE}" ]; then
|
[ "${MINOR_STABLE}" -ge "${MINOR_UNSTABLE}" ]
|
||||||
|
} || [ "${MAJOR_STABLE}" -gt "${MAJOR_UNSTABLE}" ]; then
|
||||||
|
|
||||||
echo "❎ Latest unstable version '${VERSION}' is not higher than the latest stable version '$STABLE_VERSION'."
|
echo "❎ Latest unstable version '${VERSION}' is not higher than the latest stable version '$STABLE_VERSION'."
|
||||||
if [ -z "$DEBUG" ]; then
|
if [ -z "$DEBUG" ]; then
|
||||||
|
|
573
build.sh
573
build.sh
|
@ -1,92 +1,134 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# Clones the Netbox repository with git from Github and builds the Dockerfile
|
# Clones the NetBox repository with git from Github and builds the Dockerfile
|
||||||
|
|
||||||
echo "▶️ $0 $*"
|
echo "▶️ $0 $*"
|
||||||
|
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
if [ "${1}x" == "x" ] || [ "${1}" == "--help" ] || [ "${1}" == "-h" ]; then
|
if [ "${1}x" == "x" ] || [ "${1}" == "--help" ] || [ "${1}" == "-h" ]; then
|
||||||
echo "Usage: ${0} <branch> [--push|--push-only]"
|
_BOLD=$(tput bold)
|
||||||
echo " branch The branch or tag to build. Required."
|
_GREEN=$(tput setaf 2)
|
||||||
echo " --push Pushes the built Docker image to the registry."
|
_CYAN=$(tput setaf 6)
|
||||||
echo " --push-only Only pushes the Docker image to the registry, but does not build it."
|
_CLEAR=$(tput sgr0)
|
||||||
echo ""
|
|
||||||
echo "You can use the following ENV variables to customize the build:"
|
cat <<END_OF_HELP
|
||||||
echo " SRC_ORG Which fork of netbox to use (i.e. github.com/\${SRC_ORG}/\${SRC_REPO})."
|
${_BOLD}Usage:${_CLEAR} ${0} <branch> [--push]
|
||||||
echo " Default: netbox-community"
|
|
||||||
echo " SRC_REPO The name of the repository to use (i.e. github.com/\${SRC_ORG}/\${SRC_REPO})."
|
branch The branch or tag to build. Required.
|
||||||
echo " Default: netbox"
|
--push Pushes the built container image to the registry.
|
||||||
echo " URL Where to fetch the code from."
|
|
||||||
echo " Must be a git repository. Can be private."
|
${_BOLD}You can use the following ENV variables to customize the build:${_CLEAR}
|
||||||
echo " Default: https://github.com/\${SRC_ORG}/\${SRC_REPO}.git"
|
|
||||||
echo " NETBOX_PATH The path where netbox will be checkout out."
|
SRC_ORG Which fork of netbox to use (i.e. github.com/\${SRC_ORG}/\${SRC_REPO}).
|
||||||
echo " Must not be outside of the netbox-docker repository (because of Docker)!"
|
${_GREEN}Default:${_CLEAR} netbox-community
|
||||||
echo " Default: .netbox"
|
|
||||||
echo " SKIP_GIT If defined, git is not invoked and \${NETBOX_PATH} will not be altered."
|
SRC_REPO The name of the repository to use (i.e. github.com/\${SRC_ORG}/\${SRC_REPO}).
|
||||||
echo " This may be useful, if you are manually managing the NETBOX_PATH."
|
${_GREEN}Default:${_CLEAR} netbox
|
||||||
echo " Default: undefined"
|
|
||||||
echo " TAG The version part of the docker tag."
|
URL Where to fetch the code from.
|
||||||
echo " Default:"
|
Must be a git repository. Can be private.
|
||||||
echo " When <branch>=master: latest"
|
${_GREEN}Default:${_CLEAR} https://github.com/\${SRC_ORG}/\${SRC_REPO}.git
|
||||||
echo " When <branch>=develop: snapshot"
|
|
||||||
echo " Else: same as <branch>"
|
NETBOX_PATH The path where netbox will be checkout out.
|
||||||
echo " DOCKER_REGISTRY The Docker repository's registry (i.e. '\${DOCKER_REGISTRY}/\${DOCKER_ORG}/\${DOCKER_REPO}'')"
|
Must not be outside of the netbox-docker repository (because of Docker)!
|
||||||
echo " Used for tagging the image."
|
${_GREEN}Default:${_CLEAR} .netbox
|
||||||
echo " Default: docker.io"
|
|
||||||
echo " DOCKER_ORG The Docker repository's organisation (i.e. '\${DOCKER_REGISTRY}/\${DOCKER_ORG}/\${DOCKER_REPO}'')"
|
SKIP_GIT If defined, git is not invoked and \${NETBOX_PATH} will not be altered.
|
||||||
echo " Used for tagging the image."
|
This may be useful, if you are manually managing the NETBOX_PATH.
|
||||||
echo " Default: netboxcommunity"
|
${_GREEN}Default:${_CLEAR} undefined
|
||||||
echo " DOCKER_REPO The Docker repository's name (i.e. '\${DOCKER_REGISTRY}/\${DOCKER_ORG}/\${DOCKER_REPO}'')"
|
|
||||||
echo " Used for tagging the image."
|
TAG The version part of the image tag.
|
||||||
echo " Default: netbox"
|
${_GREEN}Default:${_CLEAR}
|
||||||
echo " DOCKER_TAG The name of the tag which is applied to the image."
|
When <branch>=master: latest
|
||||||
echo " Useful for pushing into another registry than hub.docker.com."
|
When <branch>=develop: snapshot
|
||||||
echo " Default: \${DOCKER_REGISTRY}/\${DOCKER_ORG}/\${DOCKER_REPO}:\${TAG}"
|
Else: same as <branch>
|
||||||
echo " DOCKER_SHORT_TAG The name of the short tag which is applied to the"
|
|
||||||
echo " image. This is used to tag all patch releases to their"
|
IMAGE_NAMES The names used for the image including the registry
|
||||||
echo " containing version e.g. v2.5.1 -> v2.5"
|
Used for tagging the image.
|
||||||
echo " Default: \${DOCKER_REGISTRY}/\${DOCKER_ORG}/\${DOCKER_REPO}:<MAJOR>.<MINOR>"
|
${_GREEN}Default:${_CLEAR} docker.io/netboxcommunity/netbox
|
||||||
echo " DOCKERFILE The name of Dockerfile to use."
|
${_CYAN}Example:${_CLEAR} 'docker.io/netboxcommunity/netbox quay.io/netboxcommunity/netbox'
|
||||||
echo " Default: Dockerfile"
|
|
||||||
echo " DOCKER_FROM The base image to use."
|
DOCKER_TAG The name of the tag which is applied to the image.
|
||||||
echo " Default: Whatever is defined as default in the Dockerfile."
|
Useful for pushing into another registry than hub.docker.com.
|
||||||
echo " DOCKER_TARGET A specific target to build."
|
${_GREEN}Default:${_CLEAR} \${DOCKER_REGISTRY}/\${DOCKER_ORG}/\${DOCKER_REPO}:\${TAG}
|
||||||
echo " It's currently not possible to pass multiple targets."
|
|
||||||
echo " Default: main ldap"
|
DOCKER_SHORT_TAG The name of the short tag which is applied to the
|
||||||
echo " HTTP_PROXY The proxy to use for http requests."
|
image. This is used to tag all patch releases to their
|
||||||
echo " Example: http://proxy.domain.tld:3128"
|
containing version e.g. v2.5.1 -> v2.5
|
||||||
echo " Default: undefined"
|
${_GREEN}Default:${_CLEAR} \${DOCKER_REGISTRY}/\${DOCKER_ORG}/\${DOCKER_REPO}:<MAJOR>.<MINOR>
|
||||||
echo " NO_PROXY Comma-separated list of domain extensions proxy should not be used for."
|
|
||||||
echo " Example: .domain1.tld,.domain2.tld"
|
DOCKERFILE The name of Dockerfile to use.
|
||||||
echo " Default: undefined"
|
${_GREEN}Default:${_CLEAR} Dockerfile
|
||||||
echo " DEBUG If defined, the script does not stop when certain checks are unsatisfied."
|
|
||||||
echo " Default: undefined"
|
DOCKER_FROM The base image to use.
|
||||||
echo " DRY_RUN Prints all build statements instead of running them."
|
${_GREEN}Default:${_CLEAR} 'ubuntu:22.04'
|
||||||
echo " Default: undefined"
|
|
||||||
echo " GH_ACTION If defined, special 'echo' statements are enabled that set the"
|
BUILDX_PLATFORMS
|
||||||
echo " following environment variables in Github Actions:"
|
Specifies the platform(s) to build the image for.
|
||||||
echo " - FINAL_DOCKER_TAG: The final value of the DOCKER_TAG env variable"
|
${_CYAN}Example:${_CLEAR} 'linux/amd64,linux/arm64'
|
||||||
echo " Default: undefined"
|
${_GREEN}Default:${_CLEAR} 'linux/amd64'
|
||||||
echo ""
|
|
||||||
echo "Examples:"
|
BUILDX_BUILDER_NAME
|
||||||
echo " ${0} master"
|
If defined, the image build will be assigned to the given builder.
|
||||||
echo " This will fetch the latest 'master' branch, build a Docker Image and tag it"
|
If you specify this variable, make sure that the builder exists.
|
||||||
echo " 'netboxcommunity/netbox:latest'."
|
If this value is not defined, a new builx builder with the directory name of the
|
||||||
echo " ${0} develop"
|
current directory (i.e. '$(basename "${PWD}")') is created."
|
||||||
echo " This will fetch the latest 'develop' branch, build a Docker Image and tag it"
|
${_CYAN}Example:${_CLEAR} 'clever_lovelace'
|
||||||
echo " 'netboxcommunity/netbox:snapshot'."
|
${_GREEN}Default:${_CLEAR} undefined
|
||||||
echo " ${0} v2.6.6"
|
|
||||||
echo " This will fetch the 'v2.6.6' tag, build a Docker Image and tag it"
|
BUILDX_REMOVE_BUILDER
|
||||||
echo " 'netboxcommunity/netbox:v2.6.6' and 'netboxcommunity/netbox:v2.6'."
|
If defined (and only if BUILDX_BUILDER_NAME is undefined),
|
||||||
echo " ${0} develop-2.7"
|
then the buildx builder created by this script will be removed after use.
|
||||||
echo " This will fetch the 'develop-2.7' branch, build a Docker Image and tag it"
|
This is useful if you build NetBox Docker on an automated system that does
|
||||||
echo " 'netboxcommunity/netbox:develop-2.7'."
|
not manage the builders for you.
|
||||||
echo " SRC_ORG=cimnine ${0} feature-x"
|
${_CYAN}Example:${_CLEAR} 'on'
|
||||||
echo " This will fetch the 'feature-x' branch from https://github.com/cimnine/netbox.git,"
|
${_GREEN}Default:${_CLEAR} undefined
|
||||||
echo " build a Docker Image and tag it 'netboxcommunity/netbox:feature-x'."
|
|
||||||
echo " SRC_ORG=cimnine DOCKER_ORG=cimnine ${0} feature-x"
|
HTTP_PROXY The proxy to use for http requests.
|
||||||
echo " This will fetch the 'feature-x' branch from https://github.com/cimnine/netbox.git,"
|
${_CYAN}Example:${_CLEAR} http://proxy.domain.tld:3128
|
||||||
echo " build a Docker Image and tag it 'cimnine/netbox:feature-x'."
|
${_GREEN}Default:${_CLEAR} undefined
|
||||||
|
|
||||||
|
NO_PROXY Comma-separated list of domain extensions proxy should not be used for.
|
||||||
|
${_CYAN}Example:${_CLEAR} .domain1.tld,.domain2.tld
|
||||||
|
${_GREEN}Default:${_CLEAR} undefined
|
||||||
|
|
||||||
|
DEBUG If defined, the script does not stop when certain checks are unsatisfied.
|
||||||
|
${_GREEN}Default:${_CLEAR} undefined
|
||||||
|
|
||||||
|
DRY_RUN Prints all build statements instead of running them.
|
||||||
|
${_GREEN}Default:${_CLEAR} undefined
|
||||||
|
|
||||||
|
GH_ACTION If defined, special 'echo' statements are enabled that set the
|
||||||
|
following environment variables in Github Actions:
|
||||||
|
- FINAL_DOCKER_TAG: The final value of the DOCKER_TAG env variable
|
||||||
|
${_GREEN}Default:${_CLEAR} undefined
|
||||||
|
|
||||||
|
${_BOLD}Examples:${_CLEAR}
|
||||||
|
|
||||||
|
${0} master
|
||||||
|
This will fetch the latest 'master' branch, build a Docker Image and tag it
|
||||||
|
'netboxcommunity/netbox:latest'.
|
||||||
|
|
||||||
|
${0} develop
|
||||||
|
This will fetch the latest 'develop' branch, build a Docker Image and tag it
|
||||||
|
'netboxcommunity/netbox:snapshot'.
|
||||||
|
|
||||||
|
${0} v2.6.6
|
||||||
|
This will fetch the 'v2.6.6' tag, build a Docker Image and tag it
|
||||||
|
'netboxcommunity/netbox:v2.6.6' and 'netboxcommunity/netbox:v2.6'.
|
||||||
|
|
||||||
|
${0} develop-2.7
|
||||||
|
This will fetch the 'develop-2.7' branch, build a Docker Image and tag it
|
||||||
|
'netboxcommunity/netbox:develop-2.7'.
|
||||||
|
|
||||||
|
SRC_ORG=cimnine ${0} feature-x
|
||||||
|
This will fetch the 'feature-x' branch from https://github.com/cimnine/netbox.git,
|
||||||
|
build a Docker Image and tag it 'netboxcommunity/netbox:feature-x'.
|
||||||
|
|
||||||
|
SRC_ORG=cimnine DOCKER_ORG=cimnine ${0} feature-x
|
||||||
|
This will fetch the 'feature-x' branch from https://github.com/cimnine/netbox.git,
|
||||||
|
build a Docker Image and tag it 'cimnine/netbox:feature-x'.
|
||||||
|
END_OF_HELP
|
||||||
|
|
||||||
if [ "${1}x" == "x" ]; then
|
if [ "${1}x" == "x" ]; then
|
||||||
exit 1
|
exit 1
|
||||||
|
@ -95,6 +137,11 @@ if [ "${1}x" == "x" ] || [ "${1}" == "--help" ] || [ "${1}" == "-h" ]; then
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
source ./build-functions/gh-functions.sh
|
||||||
|
|
||||||
|
IMAGE_NAMES="${IMAGE_NAMES-docker.io/netboxcommunity/netbox}"
|
||||||
|
IFS=' ' read -ra IMAGE_NAMES <<<"${IMAGE_NAMES}"
|
||||||
|
|
||||||
###
|
###
|
||||||
# Enabling dry-run mode
|
# Enabling dry-run mode
|
||||||
###
|
###
|
||||||
|
@ -105,8 +152,10 @@ else
|
||||||
DRY="echo"
|
DRY="echo"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
gh_echo "::group::⤵️ Fetching the NetBox source code"
|
||||||
|
|
||||||
###
|
###
|
||||||
# Variables for fetching the source
|
# Variables for fetching the NetBox source
|
||||||
###
|
###
|
||||||
SRC_ORG="${SRC_ORG-netbox-community}"
|
SRC_ORG="${SRC_ORG-netbox-community}"
|
||||||
SRC_REPO="${SRC_REPO-netbox}"
|
SRC_REPO="${SRC_REPO-netbox}"
|
||||||
|
@ -115,17 +164,23 @@ URL="${URL-https://github.com/${SRC_ORG}/${SRC_REPO}.git}"
|
||||||
NETBOX_PATH="${NETBOX_PATH-.netbox}"
|
NETBOX_PATH="${NETBOX_PATH-.netbox}"
|
||||||
|
|
||||||
###
|
###
|
||||||
# Fetching the source
|
# Fetching the NetBox source
|
||||||
###
|
###
|
||||||
if [ "${2}" != "--push-only" ] && [ -z "${SKIP_GIT}" ] ; then
|
if [ "${2}" != "--push-only" ] && [ -z "${SKIP_GIT}" ]; then
|
||||||
echo "🌐 Checking out '${NETBOX_BRANCH}' of netbox from the url '${URL}' into '${NETBOX_PATH}'"
|
REMOTE_EXISTS=$(git ls-remote --heads --tags "${URL}" "${NETBOX_BRANCH}" | wc -l)
|
||||||
|
if [ "${REMOTE_EXISTS}" == "0" ]; then
|
||||||
|
echo "❌ Remote branch '${NETBOX_BRANCH}' not found in '${URL}'; Nothing to do"
|
||||||
|
gh_echo "::set-output name=skipped::true"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
echo "🌐 Checking out '${NETBOX_BRANCH}' of NetBox from the url '${URL}' into '${NETBOX_PATH}'"
|
||||||
if [ ! -d "${NETBOX_PATH}" ]; then
|
if [ ! -d "${NETBOX_PATH}" ]; then
|
||||||
$DRY git clone -q --depth 10 -b "${NETBOX_BRANCH}" "${URL}" "${NETBOX_PATH}"
|
$DRY git clone -q --depth 10 -b "${NETBOX_BRANCH}" "${URL}" "${NETBOX_PATH}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
(
|
(
|
||||||
$DRY cd "${NETBOX_PATH}"
|
$DRY cd "${NETBOX_PATH}"
|
||||||
|
# shellcheck disable=SC2030
|
||||||
if [ -n "${HTTP_PROXY}" ]; then
|
if [ -n "${HTTP_PROXY}" ]; then
|
||||||
git config http.proxy "${HTTP_PROXY}"
|
git config http.proxy "${HTTP_PROXY}"
|
||||||
fi
|
fi
|
||||||
|
@ -135,9 +190,12 @@ if [ "${2}" != "--push-only" ] && [ -z "${SKIP_GIT}" ] ; then
|
||||||
$DRY git checkout -qf FETCH_HEAD
|
$DRY git checkout -qf FETCH_HEAD
|
||||||
$DRY git prune
|
$DRY git prune
|
||||||
)
|
)
|
||||||
echo "✅ Checked out netbox"
|
echo "✅ Checked out NetBox"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
gh_echo "::endgroup::"
|
||||||
|
gh_echo "::group::🧮 Calculating Values"
|
||||||
|
|
||||||
###
|
###
|
||||||
# Determining the value for DOCKERFILE
|
# Determining the value for DOCKERFILE
|
||||||
# and checking whether it exists
|
# and checking whether it exists
|
||||||
|
@ -153,12 +211,19 @@ if [ ! -f "${DOCKERFILE}" ]; then
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
###
|
||||||
|
# Determining the value for DOCKER_FROM
|
||||||
|
###
|
||||||
|
if [ -z "$DOCKER_FROM" ]; then
|
||||||
|
DOCKER_FROM="ubuntu:22.04"
|
||||||
|
fi
|
||||||
|
|
||||||
###
|
###
|
||||||
# Variables for labelling the docker image
|
# Variables for labelling the docker image
|
||||||
###
|
###
|
||||||
BUILD_DATE="$(date -u '+%Y-%m-%dT%H:%M+00:00')"
|
BUILD_DATE="$(date -u '+%Y-%m-%dT%H:%M+00:00')"
|
||||||
|
|
||||||
if [ -d ".git" ]; then
|
if [ -d ".git" ] && [ -z "${SKIP_GIT}" ]; then
|
||||||
GIT_REF="$(git rev-parse HEAD)"
|
GIT_REF="$(git rev-parse HEAD)"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
@ -166,10 +231,19 @@ fi
|
||||||
PROJECT_VERSION="${PROJECT_VERSION-$(sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//' VERSION)}"
|
PROJECT_VERSION="${PROJECT_VERSION-$(sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//' VERSION)}"
|
||||||
|
|
||||||
# Get the Git information from the netbox directory
|
# Get the Git information from the netbox directory
|
||||||
if [ -d "${NETBOX_PATH}/.git" ]; then
|
if [ -d "${NETBOX_PATH}/.git" ] && [ -z "${SKIP_GIT}" ]; then
|
||||||
NETBOX_GIT_REF=$(cd ${NETBOX_PATH}; git rev-parse HEAD)
|
NETBOX_GIT_REF=$(
|
||||||
NETBOX_GIT_BRANCH=$(cd ${NETBOX_PATH}; git rev-parse --abbrev-ref HEAD)
|
cd "${NETBOX_PATH}"
|
||||||
NETBOX_GIT_URL=$(cd ${NETBOX_PATH}; git remote get-url origin)
|
git rev-parse HEAD
|
||||||
|
)
|
||||||
|
NETBOX_GIT_BRANCH=$(
|
||||||
|
cd "${NETBOX_PATH}"
|
||||||
|
git rev-parse --abbrev-ref HEAD
|
||||||
|
)
|
||||||
|
NETBOX_GIT_URL=$(
|
||||||
|
cd "${NETBOX_PATH}"
|
||||||
|
git remote get-url origin
|
||||||
|
)
|
||||||
fi
|
fi
|
||||||
|
|
||||||
###
|
###
|
||||||
|
@ -179,133 +253,206 @@ DOCKER_REGISTRY="${DOCKER_REGISTRY-docker.io}"
|
||||||
DOCKER_ORG="${DOCKER_ORG-netboxcommunity}"
|
DOCKER_ORG="${DOCKER_ORG-netboxcommunity}"
|
||||||
DOCKER_REPO="${DOCKER_REPO-netbox}"
|
DOCKER_REPO="${DOCKER_REPO-netbox}"
|
||||||
case "${NETBOX_BRANCH}" in
|
case "${NETBOX_BRANCH}" in
|
||||||
master)
|
master)
|
||||||
TAG="${TAG-latest}";;
|
TAG="${TAG-latest}"
|
||||||
develop)
|
;;
|
||||||
TAG="${TAG-snapshot}";;
|
develop)
|
||||||
*)
|
TAG="${TAG-snapshot}"
|
||||||
TAG="${TAG-$NETBOX_BRANCH}";;
|
;;
|
||||||
|
*)
|
||||||
|
TAG="${TAG-$NETBOX_BRANCH}"
|
||||||
|
;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
###
|
###
|
||||||
# Determine targets to build
|
# composing the final TARGET_DOCKER_TAG
|
||||||
###
|
###
|
||||||
DEFAULT_DOCKER_TARGETS=("main" "ldap")
|
TARGET_DOCKER_TAG="${DOCKER_TAG-${TAG}}"
|
||||||
DOCKER_TARGETS=( "${DOCKER_TARGET:-"${DEFAULT_DOCKER_TARGETS[@]}"}")
|
TARGET_DOCKER_TAG_PROJECT="${TARGET_DOCKER_TAG}-${PROJECT_VERSION}"
|
||||||
echo "🏭 Building the following targets:" "${DOCKER_TARGETS[@]}"
|
|
||||||
|
|
||||||
###
|
###
|
||||||
# Build each target
|
# composing the additional DOCKER_SHORT_TAG,
|
||||||
|
# i.e. "v2.6.1" becomes "v2.6",
|
||||||
|
# which is only relevant for version tags
|
||||||
|
# Also let "latest" follow the highest version
|
||||||
###
|
###
|
||||||
export DOCKER_BUILDKIT=${DOCKER_BUILDKIT-1}
|
if [[ "${TAG}" =~ ^v([0-9]+)\.([0-9]+)\.[0-9]+$ ]]; then
|
||||||
for DOCKER_TARGET in "${DOCKER_TARGETS[@]}"; do
|
MAJOR=${BASH_REMATCH[1]}
|
||||||
echo "🏗 Building the target '${DOCKER_TARGET}'"
|
MINOR=${BASH_REMATCH[2]}
|
||||||
|
|
||||||
###
|
TARGET_DOCKER_SHORT_TAG="${DOCKER_SHORT_TAG-v${MAJOR}.${MINOR}}"
|
||||||
# composing the final TARGET_DOCKER_TAG
|
TARGET_DOCKER_LATEST_TAG="latest"
|
||||||
###
|
TARGET_DOCKER_SHORT_TAG_PROJECT="${TARGET_DOCKER_SHORT_TAG}-${PROJECT_VERSION}"
|
||||||
TARGET_DOCKER_TAG="${DOCKER_TAG-${DOCKER_REGISTRY}/${DOCKER_ORG}/${DOCKER_REPO}:${TAG}}"
|
TARGET_DOCKER_LATEST_TAG_PROJECT="${TARGET_DOCKER_LATEST_TAG}-${PROJECT_VERSION}"
|
||||||
if [ "${DOCKER_TARGET}" != "main" ]; then
|
fi
|
||||||
TARGET_DOCKER_TAG="${TARGET_DOCKER_TAG}-${DOCKER_TARGET}"
|
|
||||||
fi
|
|
||||||
if [ -n "${GH_ACTION}" ]; then
|
|
||||||
echo "::set-env name=FINAL_DOCKER_TAG::${TARGET_DOCKER_TAG}"
|
|
||||||
echo "::set-output name=skipped::false"
|
|
||||||
fi
|
|
||||||
|
|
||||||
###
|
IMAGE_NAME_TAGS=()
|
||||||
# composing the additional DOCKER_SHORT_TAG,
|
for IMAGE_NAME in "${IMAGE_NAMES[@]}"; do
|
||||||
# i.e. "v2.6.1" becomes "v2.6",
|
IMAGE_NAME_TAGS+=("${IMAGE_NAME}:${TARGET_DOCKER_TAG}")
|
||||||
# which is only relevant for version tags
|
IMAGE_NAME_TAGS+=("${IMAGE_NAME}:${TARGET_DOCKER_TAG_PROJECT}")
|
||||||
###
|
|
||||||
if [[ "${TAG}" =~ ^v([0-9]+)\.([0-9]+)\.[0-9]+$ ]]; then
|
|
||||||
MAJOR=${BASH_REMATCH[1]}
|
|
||||||
MINOR=${BASH_REMATCH[2]}
|
|
||||||
|
|
||||||
TARGET_DOCKER_SHORT_TAG="${DOCKER_SHORT_TAG-${DOCKER_REGISTRY}/${DOCKER_ORG}/${DOCKER_REPO}:v${MAJOR}.${MINOR}}"
|
|
||||||
|
|
||||||
if [ "${DOCKER_TARGET}" != "main" ]; then
|
|
||||||
TARGET_DOCKER_SHORT_TAG="${TARGET_DOCKER_SHORT_TAG}-${DOCKER_TARGET}"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
###
|
|
||||||
# Proceeding to buils stage, except if `--push-only` is passed
|
|
||||||
###
|
|
||||||
if [ "${2}" != "--push-only" ] ; then
|
|
||||||
###
|
|
||||||
# Composing all arguments for `docker build`
|
|
||||||
###
|
|
||||||
DOCKER_BUILD_ARGS=(
|
|
||||||
--pull
|
|
||||||
--target "${DOCKER_TARGET}"
|
|
||||||
-f "${DOCKERFILE}"
|
|
||||||
-t "${TARGET_DOCKER_TAG}"
|
|
||||||
)
|
|
||||||
if [ -n "${TARGET_DOCKER_SHORT_TAG}" ]; then
|
|
||||||
DOCKER_BUILD_ARGS+=( -t "${TARGET_DOCKER_SHORT_TAG}" )
|
|
||||||
fi
|
|
||||||
|
|
||||||
# --label
|
|
||||||
if [ "${DOCKER_TARGET}" == "main" ]; then
|
|
||||||
DOCKER_BUILD_ARGS+=(
|
|
||||||
--label "ORIGINAL_TAG=${TARGET_DOCKER_TAG}"
|
|
||||||
|
|
||||||
--label "org.label-schema.build-date=${BUILD_DATE}"
|
|
||||||
--label "org.opencontainers.image.created=${BUILD_DATE}"
|
|
||||||
|
|
||||||
--label "org.label-schema.version=${PROJECT_VERSION}"
|
|
||||||
--label "org.opencontainers.image.version=${PROJECT_VERSION}"
|
|
||||||
)
|
|
||||||
if [ -d ".git" ]; then
|
|
||||||
DOCKER_BUILD_ARGS+=(
|
|
||||||
--label "org.label-schema.vcs-ref=${GIT_REF}"
|
|
||||||
--label "org.opencontainers.image.revision=${GIT_REF}"
|
|
||||||
)
|
|
||||||
fi
|
|
||||||
if [ -d "${NETBOX_PATH}/.git" ]; then
|
|
||||||
DOCKER_BUILD_ARGS+=(
|
|
||||||
--label "NETBOX_GIT_BRANCH=${NETBOX_GIT_BRANCH}"
|
|
||||||
--label "NETBOX_GIT_REF=${NETBOX_GIT_REF}"
|
|
||||||
--label "NETBOX_GIT_URL=${NETBOX_GIT_URL}"
|
|
||||||
)
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
# --build-arg
|
|
||||||
DOCKER_BUILD_ARGS+=( --build-arg "NETBOX_PATH=${NETBOX_PATH}" )
|
|
||||||
|
|
||||||
if [ -n "${DOCKER_FROM}" ]; then
|
|
||||||
DOCKER_BUILD_ARGS+=( --build-arg "FROM=${DOCKER_FROM}" )
|
|
||||||
fi
|
|
||||||
if [ -n "${HTTP_PROXY}" ]; then
|
|
||||||
DOCKER_BUILD_ARGS+=( --build-arg "http_proxy=${HTTP_PROXY}" )
|
|
||||||
DOCKER_BUILD_ARGS+=( --build-arg "https_proxy=${HTTPS_PROXY}" )
|
|
||||||
fi
|
|
||||||
if [ -n "${NO_PROXY}" ]; then
|
|
||||||
DOCKER_BUILD_ARGS+=( --build-arg "no_proxy=${NO_PROXY}" )
|
|
||||||
fi
|
|
||||||
|
|
||||||
###
|
|
||||||
# Building the docker image
|
|
||||||
###
|
|
||||||
echo "🐳 Building the Docker image '${TARGET_DOCKER_TAG}'."
|
|
||||||
$DRY docker build "${DOCKER_BUILD_ARGS[@]}" .
|
|
||||||
echo "✅ Finished building the Docker images '${TARGET_DOCKER_TAG}'"
|
|
||||||
fi
|
|
||||||
|
|
||||||
###
|
|
||||||
# Pushing the docker images if either `--push` or `--push-only` are passed
|
|
||||||
###
|
|
||||||
if [ "${2}" == "--push" ] || [ "${2}" == "--push-only" ] ; then
|
|
||||||
echo "⏫ Pushing '${TARGET_DOCKER_TAG}"
|
|
||||||
$DRY docker push "${TARGET_DOCKER_TAG}"
|
|
||||||
echo "✅ Finished pushing the Docker image '${TARGET_DOCKER_TAG}'."
|
|
||||||
|
|
||||||
if [ -n "${TARGET_DOCKER_SHORT_TAG}" ]; then
|
|
||||||
echo "⏫ Pushing '${TARGET_DOCKER_SHORT_TAG}'"
|
|
||||||
$DRY docker push "${TARGET_DOCKER_SHORT_TAG}"
|
|
||||||
echo "✅ Finished pushing the Docker image '${TARGET_DOCKER_SHORT_TAG}'."
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
done
|
done
|
||||||
|
if [ -n "${TARGET_DOCKER_SHORT_TAG}" ]; then
|
||||||
|
for IMAGE_NAME in "${IMAGE_NAMES[@]}"; do
|
||||||
|
IMAGE_NAME_TAGS+=("${IMAGE_NAME}:${TARGET_DOCKER_SHORT_TAG}")
|
||||||
|
IMAGE_NAME_TAGS+=("${IMAGE_NAME}:${TARGET_DOCKER_SHORT_TAG_PROJECT}")
|
||||||
|
IMAGE_NAME_TAGS+=("${IMAGE_NAME}:${TARGET_DOCKER_LATEST_TAG}")
|
||||||
|
IMAGE_NAME_TAGS+=("${IMAGE_NAME}:${TARGET_DOCKER_LATEST_TAG_PROJECT}")
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
|
gh_env "FINAL_DOCKER_TAG=${IMAGE_NAME_TAGS[0]}"
|
||||||
|
|
||||||
|
###
|
||||||
|
# Checking if the build is necessary,
|
||||||
|
# meaning build only if one of those values changed:
|
||||||
|
# - base image digest
|
||||||
|
# - netbox git ref (Label: netbox.git-ref)
|
||||||
|
# - netbox-docker git ref (Label: org.opencontainers.image.revision)
|
||||||
|
###
|
||||||
|
# Load information from registry (only for docker.io)
|
||||||
|
SHOULD_BUILD="false"
|
||||||
|
BUILD_REASON=""
|
||||||
|
if [ -z "${GH_ACTION}" ]; then
|
||||||
|
# Asuming non Github builds should always proceed
|
||||||
|
SHOULD_BUILD="true"
|
||||||
|
BUILD_REASON="${BUILD_REASON} interactive"
|
||||||
|
elif [[ "${IMAGE_NAME_TAGS[0]}" = docker.io* ]]; then
|
||||||
|
source ./build-functions/get-public-image-config.sh
|
||||||
|
IFS=':' read -ra DOCKER_FROM_SPLIT <<<"${DOCKER_FROM}"
|
||||||
|
if ! [[ ${DOCKER_FROM_SPLIT[0]} =~ .*/.* ]]; then
|
||||||
|
# Need to use "library/..." for images the have no two part name
|
||||||
|
DOCKER_FROM_SPLIT[0]="library/${DOCKER_FROM_SPLIT[0]}"
|
||||||
|
fi
|
||||||
|
IFS='/' read -ra ORG_REPO <<<"${IMAGE_NAMES[0]}"
|
||||||
|
echo "Checking labels for '${ORG_REPO[1]}' and '${ORG_REPO[2]}'"
|
||||||
|
BASE_LAST_LAYER=$(get_image_last_layer "${DOCKER_FROM_SPLIT[0]}" "${DOCKER_FROM_SPLIT[1]}")
|
||||||
|
mapfile -t IMAGES_LAYERS_OLD < <(get_image_layers "${ORG_REPO[1]}"/"${ORG_REPO[2]}" "${TAG}")
|
||||||
|
NETBOX_GIT_REF_OLD=$(get_image_label netbox.git-ref "${ORG_REPO[1]}"/"${ORG_REPO[2]}" "${TAG}")
|
||||||
|
GIT_REF_OLD=$(get_image_label org.opencontainers.image.revision "${ORG_REPO[1]}"/"${ORG_REPO[2]}" "${TAG}")
|
||||||
|
|
||||||
|
if ! printf '%s\n' "${IMAGES_LAYERS_OLD[@]}" | grep -q -P "^${BASE_LAST_LAYER}\$"; then
|
||||||
|
SHOULD_BUILD="true"
|
||||||
|
BUILD_REASON="${BUILD_REASON} debian"
|
||||||
|
fi
|
||||||
|
if [ "${NETBOX_GIT_REF}" != "${NETBOX_GIT_REF_OLD}" ]; then
|
||||||
|
SHOULD_BUILD="true"
|
||||||
|
BUILD_REASON="${BUILD_REASON} netbox"
|
||||||
|
fi
|
||||||
|
if [ "${GIT_REF}" != "${GIT_REF_OLD}" ]; then
|
||||||
|
SHOULD_BUILD="true"
|
||||||
|
BUILD_REASON="${BUILD_REASON} netbox-docker"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
SHOULD_BUILD="true"
|
||||||
|
BUILD_REASON="${BUILD_REASON} no-check"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ "${SHOULD_BUILD}" != "true" ]; then
|
||||||
|
echo "Build skipped because sources didn't change"
|
||||||
|
echo "::set-output name=skipped::true"
|
||||||
|
exit 0 # Nothing to do -> exit
|
||||||
|
else
|
||||||
|
gh_echo "::set-output name=skipped::false"
|
||||||
|
fi
|
||||||
|
gh_echo "::endgroup::"
|
||||||
|
|
||||||
|
###
|
||||||
|
# Build the image
|
||||||
|
###
|
||||||
|
gh_echo "::group::🏗 Building the image"
|
||||||
|
###
|
||||||
|
# Composing all arguments for `docker build`
|
||||||
|
###
|
||||||
|
DOCKER_BUILD_ARGS=(
|
||||||
|
--pull
|
||||||
|
--target main
|
||||||
|
-f "${DOCKERFILE}"
|
||||||
|
)
|
||||||
|
for IMAGE_NAME in "${IMAGE_NAME_TAGS[@]}"; do
|
||||||
|
DOCKER_BUILD_ARGS+=(-t "${IMAGE_NAME}")
|
||||||
|
done
|
||||||
|
|
||||||
|
# --label
|
||||||
|
DOCKER_BUILD_ARGS+=(
|
||||||
|
--label "netbox.original-tag=${TARGET_DOCKER_TAG_PROJECT}"
|
||||||
|
--label "org.opencontainers.image.created=${BUILD_DATE}"
|
||||||
|
--label "org.opencontainers.image.version=${PROJECT_VERSION}"
|
||||||
|
)
|
||||||
|
if [ -d ".git" ] && [ -z "${SKIP_GIT}" ]; then
|
||||||
|
DOCKER_BUILD_ARGS+=(
|
||||||
|
--label "org.opencontainers.image.revision=${GIT_REF}"
|
||||||
|
)
|
||||||
|
fi
|
||||||
|
if [ -d "${NETBOX_PATH}/.git" ] && [ -z "${SKIP_GIT}" ]; then
|
||||||
|
DOCKER_BUILD_ARGS+=(
|
||||||
|
--label "netbox.git-branch=${NETBOX_GIT_BRANCH}"
|
||||||
|
--label "netbox.git-ref=${NETBOX_GIT_REF}"
|
||||||
|
--label "netbox.git-url=${NETBOX_GIT_URL}"
|
||||||
|
)
|
||||||
|
fi
|
||||||
|
if [ -n "${BUILD_REASON}" ]; then
|
||||||
|
BUILD_REASON=$(sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//' <<<"$BUILD_REASON")
|
||||||
|
DOCKER_BUILD_ARGS+=(--label "netbox.build-reason=${BUILD_REASON}")
|
||||||
|
fi
|
||||||
|
|
||||||
|
# --build-arg
|
||||||
|
DOCKER_BUILD_ARGS+=(--build-arg "NETBOX_PATH=${NETBOX_PATH}")
|
||||||
|
|
||||||
|
if [ -n "${DOCKER_FROM}" ]; then
|
||||||
|
DOCKER_BUILD_ARGS+=(--build-arg "FROM=${DOCKER_FROM}")
|
||||||
|
fi
|
||||||
|
# shellcheck disable=SC2031
|
||||||
|
if [ -n "${HTTP_PROXY}" ]; then
|
||||||
|
DOCKER_BUILD_ARGS+=(--build-arg "http_proxy=${HTTP_PROXY}")
|
||||||
|
DOCKER_BUILD_ARGS+=(--build-arg "https_proxy=${HTTPS_PROXY}")
|
||||||
|
fi
|
||||||
|
if [ -n "${NO_PROXY}" ]; then
|
||||||
|
DOCKER_BUILD_ARGS+=(--build-arg "no_proxy=${NO_PROXY}")
|
||||||
|
fi
|
||||||
|
|
||||||
|
DOCKER_BUILD_ARGS+=(--platform "${BUILDX_PLATFORM-linux/amd64}")
|
||||||
|
if [ "${2}" == "--push" ]; then
|
||||||
|
# output type=docker does not work with pushing
|
||||||
|
DOCKER_BUILD_ARGS+=(
|
||||||
|
--output=type=image
|
||||||
|
--push
|
||||||
|
)
|
||||||
|
else
|
||||||
|
DOCKER_BUILD_ARGS+=(
|
||||||
|
--output=type=docker
|
||||||
|
)
|
||||||
|
fi
|
||||||
|
|
||||||
|
###
|
||||||
|
# Building the docker image
|
||||||
|
###
|
||||||
|
if [ -z "${BUILDX_BUILDER_NAME}" ]; then
|
||||||
|
BUILDX_BUILDER_NAME="$(basename "${PWD}")"
|
||||||
|
fi
|
||||||
|
if ! docker buildx ls | grep --quiet --word-regexp "${BUILDX_BUILDER_NAME}"; then
|
||||||
|
echo "👷 Creating new Buildx Builder '${BUILDX_BUILDER_NAME}'"
|
||||||
|
$DRY docker buildx create --name "${BUILDX_BUILDER_NAME}"
|
||||||
|
BUILDX_BUILDER_CREATED="yes"
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "🐳 Building the Docker image '${TARGET_DOCKER_TAG_PROJECT}'."
|
||||||
|
echo " Build reason set to: ${BUILD_REASON}"
|
||||||
|
$DRY docker buildx \
|
||||||
|
--builder "${BUILDX_BUILDER_NAME}" \
|
||||||
|
build \
|
||||||
|
"${DOCKER_BUILD_ARGS[@]}" \
|
||||||
|
.
|
||||||
|
echo "✅ Finished building the Docker images"
|
||||||
|
gh_echo "::endgroup::" # End group for Build
|
||||||
|
|
||||||
|
gh_echo "::group::🏗 Image Labels"
|
||||||
|
echo "🔎 Inspecting labels on '${IMAGE_NAME_TAGS[0]}'"
|
||||||
|
$DRY docker inspect "${IMAGE_NAME_TAGS[0]}" --format "{{json .Config.Labels}}" | jq
|
||||||
|
gh_echo "::endgroup::"
|
||||||
|
|
||||||
|
gh_echo "::group::🏗 Clean up"
|
||||||
|
if [ -n "${BUILDX_REMOVE_BUILDER}" ] && [ "${BUILDX_BUILDER_CREATED}" == "yes" ]; then
|
||||||
|
echo "👷 Removing Buildx Builder '${BUILDX_BUILDER_NAME}'"
|
||||||
|
$DRY docker buildx rm "${BUILDX_BUILDER_NAME}"
|
||||||
|
fi
|
||||||
|
gh_echo "::endgroup::"
|
||||||
|
|
|
@ -1,21 +1,51 @@
|
||||||
import os
|
####
|
||||||
import re
|
## We recommend to not edit this file.
|
||||||
import socket
|
## Create separate files to overwrite the settings.
|
||||||
|
## See `extra.py` as an example.
|
||||||
|
####
|
||||||
|
|
||||||
# For reference see http://netbox.readthedocs.io/en/latest/configuration/mandatory-settings/
|
import re
|
||||||
# Based on https://github.com/netbox-community/netbox/blob/develop/netbox/netbox/configuration.example.py
|
from os import environ
|
||||||
|
from os.path import abspath, dirname, join
|
||||||
|
from typing import Any, Callable, Tuple
|
||||||
|
|
||||||
|
# For reference see https://docs.netbox.dev/en/stable/configuration/
|
||||||
|
# Based on https://github.com/netbox-community/netbox/blob/develop/netbox/netbox/configuration_example.py
|
||||||
|
|
||||||
|
###
|
||||||
|
# NetBox-Docker Helper functions
|
||||||
|
###
|
||||||
|
|
||||||
# Read secret from file
|
# Read secret from file
|
||||||
def read_secret(secret_name):
|
def _read_secret(secret_name: str, default: str | None = None) -> str | None:
|
||||||
try:
|
try:
|
||||||
f = open('/run/secrets/' + secret_name, 'r', encoding='utf-8')
|
f = open('/run/secrets/' + secret_name, 'r', encoding='utf-8')
|
||||||
except EnvironmentError:
|
except EnvironmentError:
|
||||||
return ''
|
return default
|
||||||
else:
|
else:
|
||||||
with f:
|
with f:
|
||||||
return f.readline().strip()
|
return f.readline().strip()
|
||||||
|
|
||||||
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
|
# If the `map_fn` isn't defined, then the value that is read from the environment (or the default value if not found) is returned.
|
||||||
|
# If the `map_fn` is defined, then `map_fn` is invoked and the value (that was read from the environment or the default value if not found)
|
||||||
|
# is passed to it as a parameter. The value returned from `map_fn` is then the return value of this function.
|
||||||
|
# The `map_fn` is not invoked, if the value (that was read from the environment or the default value if not found) is None.
|
||||||
|
def _environ_get_and_map(variable_name: str, default: str | None = None, map_fn: Callable[[str], Any | None] = None) -> Any | None:
|
||||||
|
env_value = environ.get(variable_name, default)
|
||||||
|
|
||||||
|
if env_value == None:
|
||||||
|
return env_value
|
||||||
|
|
||||||
|
if not map_fn:
|
||||||
|
return env_value
|
||||||
|
|
||||||
|
return map_fn(env_value)
|
||||||
|
|
||||||
|
_AS_BOOL = lambda value : value.lower() == 'true'
|
||||||
|
_AS_INT = lambda value : int(value)
|
||||||
|
_AS_LIST = lambda value : list(filter(None, value.split(' ')))
|
||||||
|
|
||||||
|
_BASE_DIR = dirname(dirname(abspath(__file__)))
|
||||||
|
|
||||||
#########################
|
#########################
|
||||||
# #
|
# #
|
||||||
|
@ -27,47 +57,53 @@ BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
|
||||||
# access to the server via any other hostnames. The first FQDN in the list will be treated as the preferred name.
|
# access to the server via any other hostnames. The first FQDN in the list will be treated as the preferred name.
|
||||||
#
|
#
|
||||||
# Example: ALLOWED_HOSTS = ['netbox.example.com', 'netbox.internal.local']
|
# Example: ALLOWED_HOSTS = ['netbox.example.com', 'netbox.internal.local']
|
||||||
ALLOWED_HOSTS = os.environ.get('ALLOWED_HOSTS', '*').split(' ')
|
ALLOWED_HOSTS = environ.get('ALLOWED_HOSTS', '*').split(' ')
|
||||||
|
|
||||||
# PostgreSQL database configuration.
|
# PostgreSQL database configuration. See the Django documentation for a complete list of available parameters:
|
||||||
|
# https://docs.djangoproject.com/en/stable/ref/settings/#databases
|
||||||
DATABASE = {
|
DATABASE = {
|
||||||
'NAME': os.environ.get('DB_NAME', 'netbox'), # Database name
|
'NAME': environ.get('DB_NAME', 'netbox'), # Database name
|
||||||
'USER': os.environ.get('DB_USER', ''), # PostgreSQL username
|
'USER': environ.get('DB_USER', ''), # PostgreSQL username
|
||||||
'PASSWORD': os.environ.get('DB_PASSWORD', read_secret('db_password')),
|
'PASSWORD': _read_secret('db_password', environ.get('DB_PASSWORD', '')),
|
||||||
# PostgreSQL password
|
# PostgreSQL password
|
||||||
'HOST': os.environ.get('DB_HOST', 'localhost'), # Database server
|
'HOST': environ.get('DB_HOST', 'localhost'), # Database server
|
||||||
'PORT': os.environ.get('DB_PORT', ''), # Database port (leave blank for default)
|
'PORT': environ.get('DB_PORT', ''), # Database port (leave blank for default)
|
||||||
'OPTIONS': {'sslmode': os.environ.get('DB_SSLMODE', 'prefer')},
|
'OPTIONS': {'sslmode': environ.get('DB_SSLMODE', 'prefer')},
|
||||||
# Database connection SSLMODE
|
# Database connection SSLMODE
|
||||||
'CONN_MAX_AGE': int(os.environ.get('DB_CONN_MAX_AGE', '300')),
|
'CONN_MAX_AGE': _environ_get_and_map('DB_CONN_MAX_AGE', '300', _AS_INT),
|
||||||
# Database connection persistence
|
# Max database connection age
|
||||||
|
'DISABLE_SERVER_SIDE_CURSORS': _environ_get_and_map('DB_DISABLE_SERVER_SIDE_CURSORS', 'False', _AS_BOOL),
|
||||||
|
# Disable the use of server-side cursors transaction pooling
|
||||||
|
}
|
||||||
|
|
||||||
|
# Redis database settings. Redis is used for caching and for queuing background tasks such as webhook events. A separate
|
||||||
|
# configuration exists for each. Full connection details are required in both sections, and it is strongly recommended
|
||||||
|
# to use two separate database IDs.
|
||||||
|
REDIS = {
|
||||||
|
'tasks': {
|
||||||
|
'HOST': environ.get('REDIS_HOST', 'localhost'),
|
||||||
|
'PORT': _environ_get_and_map('REDIS_PORT', 6379, _AS_INT),
|
||||||
|
'PASSWORD': _read_secret('redis_password', environ.get('REDIS_PASSWORD', '')),
|
||||||
|
'DATABASE': _environ_get_and_map('REDIS_DATABASE', 0, _AS_INT),
|
||||||
|
'SSL': _environ_get_and_map('REDIS_SSL', 'False', _AS_BOOL),
|
||||||
|
'INSECURE_SKIP_TLS_VERIFY': _environ_get_and_map('REDIS_INSECURE_SKIP_TLS_VERIFY', 'False', _AS_BOOL),
|
||||||
|
},
|
||||||
|
'caching': {
|
||||||
|
'HOST': environ.get('REDIS_CACHE_HOST', environ.get('REDIS_HOST', 'localhost')),
|
||||||
|
'PORT': _environ_get_and_map('REDIS_CACHE_PORT', environ.get('REDIS_PORT', '6379'), _AS_INT),
|
||||||
|
'PASSWORD': _read_secret('redis_cache_password', environ.get('REDIS_CACHE_PASSWORD', environ.get('REDIS_PASSWORD', ''))),
|
||||||
|
'DATABASE': _environ_get_and_map('REDIS_CACHE_DATABASE', '1', _AS_INT),
|
||||||
|
'SSL': _environ_get_and_map('REDIS_CACHE_SSL', environ.get('REDIS_SSL', 'False'), _AS_BOOL),
|
||||||
|
'INSECURE_SKIP_TLS_VERIFY': _environ_get_and_map('REDIS_CACHE_INSECURE_SKIP_TLS_VERIFY', environ.get('REDIS_INSECURE_SKIP_TLS_VERIFY', 'False'), _AS_BOOL),
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
# This key is used for secure generation of random numbers and strings. It must never be exposed outside of this file.
|
# This key is used for secure generation of random numbers and strings. It must never be exposed outside of this file.
|
||||||
# For optimal security, SECRET_KEY should be at least 50 characters in length and contain a mix of letters, numbers, and
|
# For optimal security, SECRET_KEY should be at least 50 characters in length and contain a mix of letters, numbers, and
|
||||||
# symbols. NetBox will not run without this defined. For more information, see
|
# symbols. NetBox will not run without this defined. For more information, see
|
||||||
# https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-SECRET_KEY
|
# https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-SECRET_KEY
|
||||||
SECRET_KEY = os.environ.get('SECRET_KEY', read_secret('secret_key'))
|
SECRET_KEY = _read_secret('secret_key', environ.get('SECRET_KEY', ''))
|
||||||
|
|
||||||
# Redis database settings. The Redis database is used for caching and background processing such as webhooks
|
|
||||||
REDIS = {
|
|
||||||
'webhooks': {
|
|
||||||
'HOST': os.environ.get('REDIS_HOST', 'localhost'),
|
|
||||||
'PORT': int(os.environ.get('REDIS_PORT', 6379)),
|
|
||||||
'PASSWORD': os.environ.get('REDIS_PASSWORD', read_secret('redis_password')),
|
|
||||||
'DATABASE': int(os.environ.get('REDIS_DATABASE', 0)),
|
|
||||||
'DEFAULT_TIMEOUT': int(os.environ.get('REDIS_TIMEOUT', 300)),
|
|
||||||
'SSL': os.environ.get('REDIS_SSL', 'False').lower() == 'true',
|
|
||||||
},
|
|
||||||
'caching': {
|
|
||||||
'HOST': os.environ.get('REDIS_CACHE_HOST', os.environ.get('REDIS_HOST', 'localhost')),
|
|
||||||
'PORT': int(os.environ.get('REDIS_CACHE_PORT', os.environ.get('REDIS_PORT', 6379))),
|
|
||||||
'PASSWORD': os.environ.get('REDIS_CACHE_PASSWORD', os.environ.get('REDIS_PASSWORD', read_secret('redis_cache_password'))),
|
|
||||||
'DATABASE': int(os.environ.get('REDIS_CACHE_DATABASE', 1)),
|
|
||||||
'DEFAULT_TIMEOUT': int(os.environ.get('REDIS_CACHE_TIMEOUT', os.environ.get('REDIS_TIMEOUT', 300))),
|
|
||||||
'SSL': os.environ.get('REDIS_CACHE_SSL', os.environ.get('REDIS_SSL', 'False')).lower() == 'true',
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
#########################
|
#########################
|
||||||
# #
|
# #
|
||||||
|
@ -75,117 +111,226 @@ REDIS = {
|
||||||
# #
|
# #
|
||||||
#########################
|
#########################
|
||||||
|
|
||||||
# Specify one or more name and email address tuples representing NetBox administrators. These people will be notified of
|
# # Specify one or more name and email address tuples representing NetBox administrators. These people will be notified of
|
||||||
# application errors (assuming correct email settings are provided).
|
# # application errors (assuming correct email settings are provided).
|
||||||
ADMINS = [
|
# ADMINS = [
|
||||||
# ['John Doe', 'jdoe@example.com'],
|
# # ['John Doe', 'jdoe@example.com'],
|
||||||
]
|
# ]
|
||||||
|
|
||||||
|
if 'ALLOWED_URL_SCHEMES' in environ:
|
||||||
|
ALLOWED_URL_SCHEMES = _environ_get_and_map('ALLOWED_URL_SCHEMES', None, _AS_LIST)
|
||||||
|
|
||||||
# Optionally display a persistent banner at the top and/or bottom of every page. HTML is allowed. To display the same
|
# Optionally display a persistent banner at the top and/or bottom of every page. HTML is allowed. To display the same
|
||||||
# content in both banners, define BANNER_TOP and set BANNER_BOTTOM = BANNER_TOP.
|
# content in both banners, define BANNER_TOP and set BANNER_BOTTOM = BANNER_TOP.
|
||||||
BANNER_TOP = os.environ.get('BANNER_TOP', '')
|
if 'BANNER_TOP' in environ:
|
||||||
BANNER_BOTTOM = os.environ.get('BANNER_BOTTOM', '')
|
BANNER_TOP = environ.get('BANNER_TOP', None)
|
||||||
|
if 'BANNER_BOTTOM' in environ:
|
||||||
|
BANNER_BOTTOM = environ.get('BANNER_BOTTOM', None)
|
||||||
|
|
||||||
# Text to include on the login page above the login form. HTML is allowed.
|
# Text to include on the login page above the login form. HTML is allowed.
|
||||||
BANNER_LOGIN = os.environ.get('BANNER_LOGIN', '')
|
if 'BANNER_LOGIN' in environ:
|
||||||
|
BANNER_LOGIN = environ.get('BANNER_LOGIN', None)
|
||||||
|
|
||||||
# Base URL path if accessing NetBox within a directory. For example, if installed at http://example.com/netbox/, set:
|
# Base URL path if accessing NetBox within a directory. For example, if installed at http://example.com/netbox/, set:
|
||||||
# BASE_PATH = 'netbox/'
|
# BASE_PATH = 'netbox/'
|
||||||
BASE_PATH = os.environ.get('BASE_PATH', '')
|
BASE_PATH = environ.get('BASE_PATH', '')
|
||||||
|
|
||||||
# Cache timeout in seconds. Set to 0 to dissable caching. Defaults to 900 (15 minutes)
|
|
||||||
CACHE_TIMEOUT = int(os.environ.get('CACHE_TIMEOUT', 900))
|
|
||||||
|
|
||||||
# Maximum number of days to retain logged changes. Set to 0 to retain changes indefinitely. (Default: 90)
|
# Maximum number of days to retain logged changes. Set to 0 to retain changes indefinitely. (Default: 90)
|
||||||
CHANGELOG_RETENTION = int(os.environ.get('CHANGELOG_RETENTION', 90))
|
if 'CHANGELOG_RETENTION' in environ:
|
||||||
|
CHANGELOG_RETENTION = _environ_get_and_map('CHANGELOG_RETENTION', None, _AS_INT)
|
||||||
|
|
||||||
|
# Maximum number of days to retain job results (scripts and reports). Set to 0 to retain job results in the database indefinitely. (Default: 90)
|
||||||
|
if 'JOBRESULT_RETENTION' in environ:
|
||||||
|
JOBRESULT_RETENTION = _environ_get_and_map('JOBRESULT_RETENTION', None, _AS_INT)
|
||||||
|
|
||||||
# API Cross-Origin Resource Sharing (CORS) settings. If CORS_ORIGIN_ALLOW_ALL is set to True, all origins will be
|
# API Cross-Origin Resource Sharing (CORS) settings. If CORS_ORIGIN_ALLOW_ALL is set to True, all origins will be
|
||||||
# allowed. Otherwise, define a list of allowed origins using either CORS_ORIGIN_WHITELIST or
|
# allowed. Otherwise, define a list of allowed origins using either CORS_ORIGIN_WHITELIST or
|
||||||
# CORS_ORIGIN_REGEX_WHITELIST. For more information, see https://github.com/ottoyiu/django-cors-headers
|
# CORS_ORIGIN_REGEX_WHITELIST. For more information, see https://github.com/ottoyiu/django-cors-headers
|
||||||
CORS_ORIGIN_ALLOW_ALL = os.environ.get('CORS_ORIGIN_ALLOW_ALL', 'False').lower() == 'true'
|
CORS_ORIGIN_ALLOW_ALL = _environ_get_and_map('CORS_ORIGIN_ALLOW_ALL', 'False', _AS_BOOL)
|
||||||
CORS_ORIGIN_WHITELIST = list(filter(None, os.environ.get('CORS_ORIGIN_WHITELIST', 'https://localhost').split(' ')))
|
CORS_ORIGIN_WHITELIST = _environ_get_and_map('CORS_ORIGIN_WHITELIST', 'https://localhost', _AS_LIST)
|
||||||
CORS_ORIGIN_REGEX_WHITELIST = [re.compile(r) for r in list(filter(None, os.environ.get('CORS_ORIGIN_REGEX_WHITELIST', '').split(' ')))]
|
CORS_ORIGIN_REGEX_WHITELIST = [re.compile(r) for r in _environ_get_and_map('CORS_ORIGIN_REGEX_WHITELIST', '', _AS_LIST)]
|
||||||
|
|
||||||
# Set to True to enable server debugging. WARNING: Debugging introduces a substantial performance penalty and may reveal
|
# Set to True to enable server debugging. WARNING: Debugging introduces a substantial performance penalty and may reveal
|
||||||
# sensitive information about your installation. Only enable debugging while performing testing. Never enable debugging
|
# sensitive information about your installation. Only enable debugging while performing testing.
|
||||||
# on a production system.
|
# Never enable debugging on a production system.
|
||||||
DEBUG = os.environ.get('DEBUG', 'False').lower() == 'true'
|
DEBUG = _environ_get_and_map('DEBUG', 'False', _AS_BOOL)
|
||||||
|
|
||||||
|
# This parameter serves as a safeguard to prevent some potentially dangerous behavior,
|
||||||
|
# such as generating new database schema migrations.
|
||||||
|
# Set this to True only if you are actively developing the NetBox code base.
|
||||||
|
DEVELOPER = _environ_get_and_map('DEVELOPER', 'False', _AS_BOOL)
|
||||||
|
|
||||||
# Email settings
|
# Email settings
|
||||||
EMAIL = {
|
EMAIL = {
|
||||||
'SERVER': os.environ.get('EMAIL_SERVER', 'localhost'),
|
'SERVER': environ.get('EMAIL_SERVER', 'localhost'),
|
||||||
'PORT': int(os.environ.get('EMAIL_PORT', 25)),
|
'PORT': _environ_get_and_map('EMAIL_PORT', 25, _AS_INT),
|
||||||
'USERNAME': os.environ.get('EMAIL_USERNAME', ''),
|
'USERNAME': environ.get('EMAIL_USERNAME', ''),
|
||||||
'PASSWORD': os.environ.get('EMAIL_PASSWORD', read_secret('email_password')),
|
'PASSWORD': _read_secret('email_password', environ.get('EMAIL_PASSWORD', '')),
|
||||||
'TIMEOUT': int(os.environ.get('EMAIL_TIMEOUT', 10)), # seconds
|
'USE_SSL': _environ_get_and_map('EMAIL_USE_SSL', 'False', _AS_BOOL),
|
||||||
'FROM_EMAIL': os.environ.get('EMAIL_FROM', ''),
|
'USE_TLS': _environ_get_and_map('EMAIL_USE_TLS', 'False', _AS_BOOL),
|
||||||
|
'SSL_CERTFILE': environ.get('EMAIL_SSL_CERTFILE', ''),
|
||||||
|
'SSL_KEYFILE': environ.get('EMAIL_SSL_KEYFILE', ''),
|
||||||
|
'TIMEOUT': _environ_get_and_map('EMAIL_TIMEOUT', 10, _AS_INT), # seconds
|
||||||
|
'FROM_EMAIL': environ.get('EMAIL_FROM', ''),
|
||||||
}
|
}
|
||||||
|
|
||||||
# Enforcement of unique IP space can be toggled on a per-VRF basis.
|
# Enforcement of unique IP space can be toggled on a per-VRF basis. To enforce unique IP space within the global table
|
||||||
# To enforce unique IP space within the global table (all prefixes and IP addresses not assigned to a VRF),
|
# (all prefixes and IP addresses not assigned to a VRF), set ENFORCE_GLOBAL_UNIQUE to True.
|
||||||
# set ENFORCE_GLOBAL_UNIQUE to True.
|
if 'ENFORCE_GLOBAL_UNIQUE' in environ:
|
||||||
ENFORCE_GLOBAL_UNIQUE = os.environ.get('ENFORCE_GLOBAL_UNIQUE', 'False').lower() == 'true'
|
ENFORCE_GLOBAL_UNIQUE = _environ_get_and_map('ENFORCE_GLOBAL_UNIQUE', None, _AS_BOOL)
|
||||||
|
|
||||||
# Exempt certain models from the enforcement of view permissions. Models listed here will be viewable by all users and
|
# Exempt certain models from the enforcement of view permissions. Models listed here will be viewable by all users and
|
||||||
# by anonymous users. List models in the form `<app>.<model>`. Add '*' to this list to exempt all models.
|
# by anonymous users. List models in the form `<app>.<model>`. Add '*' to this list to exempt all models.
|
||||||
EXEMPT_VIEW_PERMISSIONS = list(filter(None, os.environ.get('EXEMPT_VIEW_PERMISSIONS', '').split(' ')))
|
EXEMPT_VIEW_PERMISSIONS = _environ_get_and_map('EXEMPT_VIEW_PERMISSIONS', '', _AS_LIST)
|
||||||
|
|
||||||
# Enable custom logging. Please see the Django documentation for detailed guidance on configuring custom logs:
|
# HTTP proxies NetBox should use when sending outbound HTTP requests (e.g. for webhooks).
|
||||||
# https://docs.djangoproject.com/en/1.11/topics/logging/
|
# HTTP_PROXIES = {
|
||||||
LOGGING = {}
|
# 'http': 'http://10.10.1.10:3128',
|
||||||
|
# 'https': 'http://10.10.1.10:1080',
|
||||||
|
# }
|
||||||
|
|
||||||
|
# IP addresses recognized as internal to the system. The debugging toolbar will be available only to clients accessing
|
||||||
|
# NetBox from an internal IP.
|
||||||
|
INTERNAL_IPS = _environ_get_and_map('INTERNAL_IPS', '127.0.0.1 ::1', _AS_LIST)
|
||||||
|
|
||||||
|
# Enable GraphQL API.
|
||||||
|
if 'GRAPHQL_ENABLED' in environ:
|
||||||
|
GRAPHQL_ENABLED = _environ_get_and_map('GRAPHQL_ENABLED', None, _AS_BOOL)
|
||||||
|
|
||||||
|
# # Enable custom logging. Please see the Django documentation for detailed guidance on configuring custom logs:
|
||||||
|
# # https://docs.djangoproject.com/en/stable/topics/logging/
|
||||||
|
# LOGGING = {}
|
||||||
|
|
||||||
|
# Automatically reset the lifetime of a valid session upon each authenticated request. Enables users to remain
|
||||||
|
# authenticated to NetBox indefinitely.
|
||||||
|
LOGIN_PERSISTENCE = _environ_get_and_map('LOGIN_PERSISTENCE', 'False', _AS_BOOL)
|
||||||
|
|
||||||
# Setting this to True will permit only authenticated users to access any part of NetBox. By default, anonymous users
|
# Setting this to True will permit only authenticated users to access any part of NetBox. By default, anonymous users
|
||||||
# are permitted to access most data in NetBox (excluding secrets) but not make any changes.
|
# are permitted to access most data in NetBox (excluding secrets) but not make any changes.
|
||||||
LOGIN_REQUIRED = os.environ.get('LOGIN_REQUIRED', 'False').lower() == 'true'
|
LOGIN_REQUIRED = _environ_get_and_map('LOGIN_REQUIRED', 'False', _AS_BOOL)
|
||||||
|
|
||||||
|
# The length of time (in seconds) for which a user will remain logged into the web UI before being prompted to
|
||||||
|
# re-authenticate. (Default: 1209600 [14 days])
|
||||||
|
LOGIN_TIMEOUT = _environ_get_and_map('LOGIN_TIMEOUT', 1209600, _AS_INT)
|
||||||
|
|
||||||
# Setting this to True will display a "maintenance mode" banner at the top of every page.
|
# Setting this to True will display a "maintenance mode" banner at the top of every page.
|
||||||
MAINTENANCE_MODE = os.environ.get('MAINTENANCE_MODE', 'False').lower() == 'true'
|
if 'MAINTENANCE_MODE' in environ:
|
||||||
|
MAINTENANCE_MODE = _environ_get_and_map('MAINTENANCE_MODE', None, _AS_BOOL)
|
||||||
|
|
||||||
|
# Maps provider
|
||||||
|
if 'MAPS_URL' in environ:
|
||||||
|
MAPS_URL = environ.get('MAPS_URL', None)
|
||||||
|
|
||||||
# An API consumer can request an arbitrary number of objects =by appending the "limit" parameter to the URL (e.g.
|
# An API consumer can request an arbitrary number of objects =by appending the "limit" parameter to the URL (e.g.
|
||||||
# "?limit=1000"). This setting defines the maximum limit. Setting it to 0 or None will allow an API consumer to request
|
# "?limit=1000"). This setting defines the maximum limit. Setting it to 0 or None will allow an API consumer to request
|
||||||
# all objects by specifying "?limit=0".
|
# all objects by specifying "?limit=0".
|
||||||
MAX_PAGE_SIZE = int(os.environ.get('MAX_PAGE_SIZE', 1000))
|
if 'MAX_PAGE_SIZE' in environ:
|
||||||
|
MAX_PAGE_SIZE = _environ_get_and_map('MAX_PAGE_SIZE', None, _AS_INT)
|
||||||
|
|
||||||
# The file path where uploaded media such as image attachments are stored. A trailing slash is not needed. Note that
|
# The file path where uploaded media such as image attachments are stored. A trailing slash is not needed. Note that
|
||||||
# the default value of this setting is derived from the installed location.
|
# the default value of this setting is derived from the installed location.
|
||||||
MEDIA_ROOT = os.environ.get('MEDIA_ROOT', os.path.join(BASE_DIR, 'media'))
|
MEDIA_ROOT = environ.get('MEDIA_ROOT', join(_BASE_DIR, 'media'))
|
||||||
|
|
||||||
# Expose Prometheus monitoring metrics at the HTTP endpoint '/metrics'
|
# Expose Prometheus monitoring metrics at the HTTP endpoint '/metrics'
|
||||||
METRICS_ENABLED = os.environ.get('METRICS_ENABLED', 'False').lower() == 'true'
|
METRICS_ENABLED = _environ_get_and_map('METRICS_ENABLED', 'False', _AS_BOOL)
|
||||||
|
|
||||||
# Credentials that NetBox will use to access live devices.
|
# Credentials that NetBox will uses to authenticate to devices when connecting via NAPALM.
|
||||||
NAPALM_USERNAME = os.environ.get('NAPALM_USERNAME', '')
|
if 'NAPALM_USERNAME' in environ:
|
||||||
NAPALM_PASSWORD = os.environ.get('NAPALM_PASSWORD', read_secret('napalm_password'))
|
NAPALM_USERNAME = environ.get('NAPALM_USERNAME', None)
|
||||||
|
if 'NAPALM_PASSWORD' in environ:
|
||||||
|
NAPALM_PASSWORD = _read_secret('napalm_password', environ.get('NAPALM_PASSWORD', None))
|
||||||
|
|
||||||
# NAPALM timeout (in seconds). (Default: 30)
|
# NAPALM timeout (in seconds). (Default: 30)
|
||||||
NAPALM_TIMEOUT = int(os.environ.get('NAPALM_TIMEOUT', 30))
|
if 'NAPALM_TIMEOUT' in environ:
|
||||||
|
NAPALM_TIMEOUT = _environ_get_and_map('NAPALM_TIMEOUT', None, _AS_INT)
|
||||||
|
|
||||||
# NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must
|
# # NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must
|
||||||
# be provided as a dictionary.
|
# # be provided as a dictionary.
|
||||||
NAPALM_ARGS = {}
|
# NAPALM_ARGS = None
|
||||||
|
|
||||||
# Determine how many objects to display per page within a list. (Default: 50)
|
# Determine how many objects to display per page within a list. (Default: 50)
|
||||||
PAGINATE_COUNT = int(os.environ.get('PAGINATE_COUNT', 50))
|
if 'PAGINATE_COUNT' in environ:
|
||||||
|
PAGINATE_COUNT = _environ_get_and_map('PAGINATE_COUNT', None, _AS_INT)
|
||||||
|
|
||||||
|
# # Enable installed plugins. Add the name of each plugin to the list.
|
||||||
|
# PLUGINS = []
|
||||||
|
|
||||||
|
# # Plugins configuration settings. These settings are used by various plugins that the user may have installed.
|
||||||
|
# # Each key in the dictionary is the name of an installed plugin and its value is a dictionary of settings.
|
||||||
|
# PLUGINS_CONFIG = {
|
||||||
|
# }
|
||||||
|
|
||||||
# When determining the primary IP address for a device, IPv6 is preferred over IPv4 by default. Set this to True to
|
# When determining the primary IP address for a device, IPv6 is preferred over IPv4 by default. Set this to True to
|
||||||
# prefer IPv4 instead.
|
# prefer IPv4 instead.
|
||||||
PREFER_IPV4 = os.environ.get('PREFER_IPV4', 'False').lower() == 'true'
|
if 'PREFER_IPV4' in environ:
|
||||||
|
PREFER_IPV4 = _environ_get_and_map('PREFER_IPV4', None, _AS_BOOL)
|
||||||
|
|
||||||
|
# The default value for the amperage field when creating new power feeds.
|
||||||
|
if 'POWERFEED_DEFAULT_AMPERAGE' in environ:
|
||||||
|
POWERFEED_DEFAULT_AMPERAGE = _environ_get_and_map('POWERFEED_DEFAULT_AMPERAGE', None, _AS_INT)
|
||||||
|
|
||||||
|
# The default value (percentage) for the max_utilization field when creating new power feeds.
|
||||||
|
if 'POWERFEED_DEFAULT_MAX_UTILIZATION' in environ:
|
||||||
|
POWERFEED_DEFAULT_MAX_UTILIZATION = _environ_get_and_map('POWERFEED_DEFAULT_MAX_UTILIZATION', None, _AS_INT)
|
||||||
|
|
||||||
|
# The default value for the voltage field when creating new power feeds.
|
||||||
|
if 'POWERFEED_DEFAULT_VOLTAGE' in environ:
|
||||||
|
POWERFEED_DEFAULT_VOLTAGE = _environ_get_and_map('POWERFEED_DEFAULT_VOLTAGE', None, _AS_INT)
|
||||||
|
|
||||||
|
# Rack elevation size defaults, in pixels. For best results, the ratio of width to height should be roughly 10:1.
|
||||||
|
if 'RACK_ELEVATION_DEFAULT_UNIT_HEIGHT' in environ:
|
||||||
|
RACK_ELEVATION_DEFAULT_UNIT_HEIGHT = _environ_get_and_map('RACK_ELEVATION_DEFAULT_UNIT_HEIGHT', None, _AS_INT)
|
||||||
|
if 'RACK_ELEVATION_DEFAULT_UNIT_WIDTH' in environ:
|
||||||
|
RACK_ELEVATION_DEFAULT_UNIT_WIDTH = _environ_get_and_map('RACK_ELEVATION_DEFAULT_UNIT_WIDTH', None, _AS_INT)
|
||||||
|
|
||||||
|
# Remote authentication support
|
||||||
|
REMOTE_AUTH_ENABLED = _environ_get_and_map('REMOTE_AUTH_ENABLED', 'False', _AS_BOOL)
|
||||||
|
REMOTE_AUTH_BACKEND = environ.get('REMOTE_AUTH_BACKEND', 'netbox.authentication.RemoteUserBackend')
|
||||||
|
REMOTE_AUTH_HEADER = environ.get('REMOTE_AUTH_HEADER', 'HTTP_REMOTE_USER')
|
||||||
|
REMOTE_AUTH_AUTO_CREATE_USER = _environ_get_and_map('REMOTE_AUTH_AUTO_CREATE_USER', 'True', _AS_BOOL)
|
||||||
|
REMOTE_AUTH_DEFAULT_GROUPS = _environ_get_and_map('REMOTE_AUTH_DEFAULT_GROUPS', '', _AS_LIST)
|
||||||
|
# REMOTE_AUTH_DEFAULT_PERMISSIONS = {}
|
||||||
|
|
||||||
|
# This repository is used to check whether there is a new release of NetBox available. Set to None to disable the
|
||||||
|
# version check or use the URL below to check for release in the official NetBox repository.
|
||||||
|
RELEASE_CHECK_URL = environ.get('RELEASE_CHECK_URL', None)
|
||||||
|
# RELEASE_CHECK_URL = 'https://api.github.com/repos/netbox-community/netbox/releases'
|
||||||
|
|
||||||
# The file path where custom reports will be stored. A trailing slash is not needed. Note that the default value of
|
# The file path where custom reports will be stored. A trailing slash is not needed. Note that the default value of
|
||||||
# this setting is derived from the installed location.
|
# this setting is derived from the installed location.
|
||||||
REPORTS_ROOT = os.environ.get('REPORTS_ROOT', '/etc/netbox/reports')
|
REPORTS_ROOT = environ.get('REPORTS_ROOT', '/etc/netbox/reports')
|
||||||
|
|
||||||
|
# Maximum execution time for background tasks, in seconds.
|
||||||
|
RQ_DEFAULT_TIMEOUT = _environ_get_and_map('RQ_DEFAULT_TIMEOUT', 300, _AS_INT)
|
||||||
|
|
||||||
# The file path where custom scripts will be stored. A trailing slash is not needed. Note that the default value of
|
# The file path where custom scripts will be stored. A trailing slash is not needed. Note that the default value of
|
||||||
# this setting is derived from the installed location.
|
# this setting is derived from the installed location.
|
||||||
SCRIPTS_ROOT = os.environ.get('SCRIPTS_ROOT', '/etc/netbox/scripts')
|
SCRIPTS_ROOT = environ.get('SCRIPTS_ROOT', '/etc/netbox/scripts')
|
||||||
|
|
||||||
|
# The name to use for the csrf token cookie.
|
||||||
|
CSRF_COOKIE_NAME = environ.get('CSRF_COOKIE_NAME', 'csrftoken')
|
||||||
|
|
||||||
|
# Cross-Site-Request-Forgery-Attack settings. If Netbox is sitting behind a reverse proxy, you might need to set the CSRF_TRUSTED_ORIGINS flag.
|
||||||
|
# Django 4.0 requires to specify the URL Scheme in this setting. An example environment variable could be specified like:
|
||||||
|
# CSRF_TRUSTED_ORIGINS=https://demo.netbox.dev http://demo.netbox.dev
|
||||||
|
CSRF_TRUSTED_ORIGINS = _environ_get_and_map('CSRF_TRUSTED_ORIGINS', '', _AS_LIST)
|
||||||
|
|
||||||
|
# The name to use for the session cookie.
|
||||||
|
SESSION_COOKIE_NAME = environ.get('SESSION_COOKIE_NAME', 'sessionid')
|
||||||
|
|
||||||
|
# By default, NetBox will store session data in the database. Alternatively, a file path can be specified here to use
|
||||||
|
# local file storage instead. (This can be useful for enabling authentication on a standby instance with read-only
|
||||||
|
# database access.) Note that the user as which NetBox runs must have read and write permissions to this path.
|
||||||
|
SESSION_FILE_PATH = environ.get('SESSION_FILE_PATH', environ.get('SESSIONS_ROOT', None))
|
||||||
|
|
||||||
# Time zone (default: UTC)
|
# Time zone (default: UTC)
|
||||||
TIME_ZONE = os.environ.get('TIME_ZONE', 'UTC')
|
TIME_ZONE = environ.get('TIME_ZONE', 'UTC')
|
||||||
|
|
||||||
# Date/time formatting. See the following link for supported formats:
|
# Date/time formatting. See the following link for supported formats:
|
||||||
# https://docs.djangoproject.com/en/dev/ref/templates/builtins/#date
|
# https://docs.djangoproject.com/en/stable/ref/templates/builtins/#date
|
||||||
DATE_FORMAT = os.environ.get('DATE_FORMAT', 'N j, Y')
|
DATE_FORMAT = environ.get('DATE_FORMAT', 'N j, Y')
|
||||||
SHORT_DATE_FORMAT = os.environ.get('SHORT_DATE_FORMAT', 'Y-m-d')
|
SHORT_DATE_FORMAT = environ.get('SHORT_DATE_FORMAT', 'Y-m-d')
|
||||||
TIME_FORMAT = os.environ.get('TIME_FORMAT', 'g:i a')
|
TIME_FORMAT = environ.get('TIME_FORMAT', 'g:i a')
|
||||||
SHORT_TIME_FORMAT = os.environ.get('SHORT_TIME_FORMAT', 'H:i:s')
|
SHORT_TIME_FORMAT = environ.get('SHORT_TIME_FORMAT', 'H:i:s')
|
||||||
DATETIME_FORMAT = os.environ.get('DATETIME_FORMAT', 'N j, Y g:i a')
|
DATETIME_FORMAT = environ.get('DATETIME_FORMAT', 'N j, Y g:i a')
|
||||||
SHORT_DATETIME_FORMAT = os.environ.get('SHORT_DATETIME_FORMAT', 'Y-m-d H:i')
|
SHORT_DATETIME_FORMAT = environ.get('SHORT_DATETIME_FORMAT', 'Y-m-d H:i')
|
||||||
|
|
|
@ -0,0 +1,55 @@
|
||||||
|
####
|
||||||
|
## This file contains extra configuration options that can't be configured
|
||||||
|
## directly through environment variables.
|
||||||
|
####
|
||||||
|
|
||||||
|
## Specify one or more name and email address tuples representing NetBox administrators. These people will be notified of
|
||||||
|
## application errors (assuming correct email settings are provided).
|
||||||
|
# ADMINS = [
|
||||||
|
# # ['John Doe', 'jdoe@example.com'],
|
||||||
|
# ]
|
||||||
|
|
||||||
|
|
||||||
|
## URL schemes that are allowed within links in NetBox
|
||||||
|
# ALLOWED_URL_SCHEMES = (
|
||||||
|
# 'file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp',
|
||||||
|
# )
|
||||||
|
|
||||||
|
|
||||||
|
## NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must
|
||||||
|
## be provided as a dictionary.
|
||||||
|
# NAPALM_ARGS = {}
|
||||||
|
|
||||||
|
|
||||||
|
## Enable installed plugins. Add the name of each plugin to the list.
|
||||||
|
# from netbox.configuration.configuration import PLUGINS
|
||||||
|
# PLUGINS.append('my_plugin')
|
||||||
|
|
||||||
|
## Plugins configuration settings. These settings are used by various plugins that the user may have installed.
|
||||||
|
## Each key in the dictionary is the name of an installed plugin and its value is a dictionary of settings.
|
||||||
|
# from netbox.configuration.configuration import PLUGINS_CONFIG
|
||||||
|
# PLUGINS_CONFIG['my_plugin'] = {
|
||||||
|
# 'foo': 'bar',
|
||||||
|
# 'buzz': 'bazz'
|
||||||
|
# }
|
||||||
|
|
||||||
|
|
||||||
|
## Remote authentication support
|
||||||
|
# REMOTE_AUTH_DEFAULT_PERMISSIONS = {}
|
||||||
|
|
||||||
|
|
||||||
|
## By default uploaded media is stored on the local filesystem. Using Django-storages is also supported. Provide the
|
||||||
|
## class path of the storage driver in STORAGE_BACKEND and any configuration options in STORAGE_CONFIG. For example:
|
||||||
|
# STORAGE_BACKEND = 'storages.backends.s3boto3.S3Boto3Storage'
|
||||||
|
# STORAGE_CONFIG = {
|
||||||
|
# 'AWS_ACCESS_KEY_ID': 'Key ID',
|
||||||
|
# 'AWS_SECRET_ACCESS_KEY': 'Secret',
|
||||||
|
# 'AWS_STORAGE_BUCKET_NAME': 'netbox',
|
||||||
|
# 'AWS_S3_REGION_NAME': 'eu-west-1',
|
||||||
|
# }
|
||||||
|
|
||||||
|
|
||||||
|
## This file can contain arbitrary Python code, e.g.:
|
||||||
|
# from datetime import datetime
|
||||||
|
# now = datetime.now().strftime("%d/%m/%Y %H:%M:%S")
|
||||||
|
# BANNER_TOP = f'<marquee width="200px">This instance started on {now}.</marquee>'
|
|
@ -1,8 +0,0 @@
|
||||||
command = '/usr/bin/gunicorn'
|
|
||||||
pythonpath = '/opt/netbox/netbox'
|
|
||||||
bind = '0.0.0.0:8001'
|
|
||||||
workers = 3
|
|
||||||
errorlog = '-'
|
|
||||||
accesslog = '-'
|
|
||||||
capture_output = False
|
|
||||||
loglevel = 'debug'
|
|
|
@ -0,0 +1,28 @@
|
||||||
|
####
|
||||||
|
## This file contains extra configuration options that can't be configured
|
||||||
|
## directly through environment variables.
|
||||||
|
## All vairables set here overwrite any existing found in ldap_config.py
|
||||||
|
####
|
||||||
|
|
||||||
|
# # This Python script inherits all the imports from ldap_config.py
|
||||||
|
# from django_auth_ldap.config import LDAPGroupQuery # Imported since not in ldap_config.py
|
||||||
|
|
||||||
|
# # Sets a base requirement of membetship to netbox-user-ro, netbox-user-rw, or netbox-user-admin.
|
||||||
|
# AUTH_LDAP_REQUIRE_GROUP = (
|
||||||
|
# LDAPGroupQuery("cn=netbox-user-ro,ou=groups,dc=example,dc=com")
|
||||||
|
# | LDAPGroupQuery("cn=netbox-user-rw,ou=groups,dc=example,dc=com")
|
||||||
|
# | LDAPGroupQuery("cn=netbox-user-admin,ou=groups,dc=example,dc=com")
|
||||||
|
# )
|
||||||
|
|
||||||
|
# # Sets LDAP Flag groups variables with example.
|
||||||
|
# AUTH_LDAP_USER_FLAGS_BY_GROUP = {
|
||||||
|
# "is_staff": (
|
||||||
|
# LDAPGroupQuery("cn=netbox-user-ro,ou=groups,dc=example,dc=com")
|
||||||
|
# | LDAPGroupQuery("cn=netbox-user-rw,ou=groups,dc=example,dc=com")
|
||||||
|
# | LDAPGroupQuery("cn=netbox-user-admin,ou=groups,dc=example,dc=com")
|
||||||
|
# ),
|
||||||
|
# "is_superuser": "cn=netbox-user-admin,ou=groups,dc=example,dc=com",
|
||||||
|
# }
|
||||||
|
|
||||||
|
# # Sets LDAP Mirror groups variables with example groups
|
||||||
|
# AUTH_LDAP_MIRROR_GROUPS = ["netbox-user-ro", "netbox-user-rw", "netbox-user-admin"]
|
|
@ -0,0 +1,103 @@
|
||||||
|
from importlib import import_module
|
||||||
|
from os import environ
|
||||||
|
|
||||||
|
import ldap
|
||||||
|
from django_auth_ldap.config import LDAPSearch
|
||||||
|
|
||||||
|
|
||||||
|
# Read secret from file
|
||||||
|
def _read_secret(secret_name, default=None):
|
||||||
|
try:
|
||||||
|
f = open('/run/secrets/' + secret_name, 'r', encoding='utf-8')
|
||||||
|
except EnvironmentError:
|
||||||
|
return default
|
||||||
|
else:
|
||||||
|
with f:
|
||||||
|
return f.readline().strip()
|
||||||
|
|
||||||
|
# Import and return the group type based on string name
|
||||||
|
def _import_group_type(group_type_name):
|
||||||
|
mod = import_module('django_auth_ldap.config')
|
||||||
|
try:
|
||||||
|
return getattr(mod, group_type_name)()
|
||||||
|
except:
|
||||||
|
return None
|
||||||
|
|
||||||
|
# Server URI
|
||||||
|
AUTH_LDAP_SERVER_URI = environ.get('AUTH_LDAP_SERVER_URI', '')
|
||||||
|
|
||||||
|
# The following may be needed if you are binding to Active Directory.
|
||||||
|
AUTH_LDAP_CONNECTION_OPTIONS = {
|
||||||
|
ldap.OPT_REFERRALS: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
AUTH_LDAP_BIND_AS_AUTHENTICATING_USER = environ.get('AUTH_LDAP_BIND_AS_AUTHENTICATING_USER', 'False').lower() == 'true'
|
||||||
|
|
||||||
|
# Set the DN and password for the NetBox service account if needed.
|
||||||
|
if not AUTH_LDAP_BIND_AS_AUTHENTICATING_USER:
|
||||||
|
AUTH_LDAP_BIND_DN = environ.get('AUTH_LDAP_BIND_DN', '')
|
||||||
|
AUTH_LDAP_BIND_PASSWORD = _read_secret('auth_ldap_bind_password', environ.get('AUTH_LDAP_BIND_PASSWORD', ''))
|
||||||
|
|
||||||
|
# Set a string template that describes any user’s distinguished name based on the username.
|
||||||
|
AUTH_LDAP_USER_DN_TEMPLATE = environ.get('AUTH_LDAP_USER_DN_TEMPLATE', None)
|
||||||
|
|
||||||
|
# Enable STARTTLS for ldap authentication.
|
||||||
|
AUTH_LDAP_START_TLS = environ.get('AUTH_LDAP_START_TLS', 'False').lower() == 'true'
|
||||||
|
|
||||||
|
# Include this setting if you want to ignore certificate errors. This might be needed to accept a self-signed cert.
|
||||||
|
# Note that this is a NetBox-specific setting which sets:
|
||||||
|
# ldap.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, ldap.OPT_X_TLS_NEVER)
|
||||||
|
LDAP_IGNORE_CERT_ERRORS = environ.get('LDAP_IGNORE_CERT_ERRORS', 'False').lower() == 'true'
|
||||||
|
|
||||||
|
# Include this setting if you want to validate the LDAP server certificates against a CA certificate directory on your server
|
||||||
|
# Note that this is a NetBox-specific setting which sets:
|
||||||
|
# ldap.set_option(ldap.OPT_X_TLS_CACERTDIR, LDAP_CA_CERT_DIR)
|
||||||
|
LDAP_CA_CERT_DIR = environ.get('LDAP_CA_CERT_DIR', None)
|
||||||
|
|
||||||
|
# Include this setting if you want to validate the LDAP server certificates against your own CA.
|
||||||
|
# Note that this is a NetBox-specific setting which sets:
|
||||||
|
# ldap.set_option(ldap.OPT_X_TLS_CACERTFILE, LDAP_CA_CERT_FILE)
|
||||||
|
LDAP_CA_CERT_FILE = environ.get('LDAP_CA_CERT_FILE', None)
|
||||||
|
|
||||||
|
AUTH_LDAP_USER_SEARCH_BASEDN = environ.get('AUTH_LDAP_USER_SEARCH_BASEDN', '')
|
||||||
|
AUTH_LDAP_USER_SEARCH_ATTR = environ.get('AUTH_LDAP_USER_SEARCH_ATTR', 'sAMAccountName')
|
||||||
|
AUTH_LDAP_USER_SEARCH = LDAPSearch(
|
||||||
|
AUTH_LDAP_USER_SEARCH_BASEDN,
|
||||||
|
ldap.SCOPE_SUBTREE,
|
||||||
|
"(" + AUTH_LDAP_USER_SEARCH_ATTR + "=%(user)s)"
|
||||||
|
)
|
||||||
|
|
||||||
|
# This search ought to return all groups to which the user belongs. django_auth_ldap uses this to determine group
|
||||||
|
# heirarchy.
|
||||||
|
AUTH_LDAP_GROUP_SEARCH_BASEDN = environ.get('AUTH_LDAP_GROUP_SEARCH_BASEDN', '')
|
||||||
|
AUTH_LDAP_GROUP_SEARCH_CLASS = environ.get('AUTH_LDAP_GROUP_SEARCH_CLASS', 'group')
|
||||||
|
AUTH_LDAP_GROUP_SEARCH = LDAPSearch(AUTH_LDAP_GROUP_SEARCH_BASEDN, ldap.SCOPE_SUBTREE,
|
||||||
|
"(objectClass=" + AUTH_LDAP_GROUP_SEARCH_CLASS + ")")
|
||||||
|
AUTH_LDAP_GROUP_TYPE = _import_group_type(environ.get('AUTH_LDAP_GROUP_TYPE', 'GroupOfNamesType'))
|
||||||
|
|
||||||
|
# Define a group required to login.
|
||||||
|
AUTH_LDAP_REQUIRE_GROUP = environ.get('AUTH_LDAP_REQUIRE_GROUP_DN')
|
||||||
|
|
||||||
|
# Define special user types using groups. Exercise great caution when assigning superuser status.
|
||||||
|
AUTH_LDAP_USER_FLAGS_BY_GROUP = {}
|
||||||
|
|
||||||
|
if AUTH_LDAP_REQUIRE_GROUP is not None:
|
||||||
|
AUTH_LDAP_USER_FLAGS_BY_GROUP = {
|
||||||
|
"is_active": environ.get('AUTH_LDAP_REQUIRE_GROUP_DN', ''),
|
||||||
|
"is_staff": environ.get('AUTH_LDAP_IS_ADMIN_DN', ''),
|
||||||
|
"is_superuser": environ.get('AUTH_LDAP_IS_SUPERUSER_DN', '')
|
||||||
|
}
|
||||||
|
|
||||||
|
# For more granular permissions, we can map LDAP groups to Django groups.
|
||||||
|
AUTH_LDAP_FIND_GROUP_PERMS = environ.get('AUTH_LDAP_FIND_GROUP_PERMS', 'True').lower() == 'true'
|
||||||
|
AUTH_LDAP_MIRROR_GROUPS = environ.get('AUTH_LDAP_MIRROR_GROUPS', '').lower() == 'true'
|
||||||
|
|
||||||
|
# Cache groups for one hour to reduce LDAP traffic
|
||||||
|
AUTH_LDAP_CACHE_TIMEOUT = int(environ.get('AUTH_LDAP_CACHE_TIMEOUT', 3600))
|
||||||
|
|
||||||
|
# Populate the Django user from the LDAP directory.
|
||||||
|
AUTH_LDAP_USER_ATTR_MAP = {
|
||||||
|
"first_name": environ.get('AUTH_LDAP_ATTR_FIRSTNAME', 'givenName'),
|
||||||
|
"last_name": environ.get('AUTH_LDAP_ATTR_LASTNAME', 'sn'),
|
||||||
|
"email": environ.get('AUTH_LDAP_ATTR_MAIL', 'mail')
|
||||||
|
}
|
|
@ -1,81 +0,0 @@
|
||||||
import ldap
|
|
||||||
import os
|
|
||||||
|
|
||||||
from django_auth_ldap.config import LDAPSearch
|
|
||||||
from importlib import import_module
|
|
||||||
|
|
||||||
# Read secret from file
|
|
||||||
def read_secret(secret_name):
|
|
||||||
try:
|
|
||||||
f = open('/run/secrets/' + secret_name, 'r', encoding='utf-8')
|
|
||||||
except EnvironmentError:
|
|
||||||
return ''
|
|
||||||
else:
|
|
||||||
with f:
|
|
||||||
return f.readline().strip()
|
|
||||||
|
|
||||||
# Import and return the group type based on string name
|
|
||||||
def import_group_type(group_type_name):
|
|
||||||
mod = import_module('django_auth_ldap.config')
|
|
||||||
try:
|
|
||||||
return getattr(mod, group_type_name)()
|
|
||||||
except:
|
|
||||||
return None
|
|
||||||
|
|
||||||
# Server URI
|
|
||||||
AUTH_LDAP_SERVER_URI = os.environ.get('AUTH_LDAP_SERVER_URI', '')
|
|
||||||
|
|
||||||
# The following may be needed if you are binding to Active Directory.
|
|
||||||
AUTH_LDAP_CONNECTION_OPTIONS = {
|
|
||||||
ldap.OPT_REFERRALS: 0
|
|
||||||
}
|
|
||||||
|
|
||||||
# Set the DN and password for the NetBox service account.
|
|
||||||
AUTH_LDAP_BIND_DN = os.environ.get('AUTH_LDAP_BIND_DN', '')
|
|
||||||
AUTH_LDAP_BIND_PASSWORD = os.environ.get('AUTH_LDAP_BIND_PASSWORD', read_secret('auth_ldap_bind_password'))
|
|
||||||
|
|
||||||
# Set a string template that describes any user’s distinguished name based on the username.
|
|
||||||
AUTH_LDAP_USER_DN_TEMPLATE = os.environ.get('AUTH_LDAP_USER_DN_TEMPLATE', None)
|
|
||||||
|
|
||||||
# Include this setting if you want to ignore certificate errors. This might be needed to accept a self-signed cert.
|
|
||||||
# Note that this is a NetBox-specific setting which sets:
|
|
||||||
# ldap.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, ldap.OPT_X_TLS_NEVER)
|
|
||||||
LDAP_IGNORE_CERT_ERRORS = os.environ.get('LDAP_IGNORE_CERT_ERRORS', 'False').lower() == 'true'
|
|
||||||
|
|
||||||
AUTH_LDAP_USER_SEARCH_BASEDN = os.environ.get('AUTH_LDAP_USER_SEARCH_BASEDN', '')
|
|
||||||
AUTH_LDAP_USER_SEARCH_ATTR = os.environ.get('AUTH_LDAP_USER_SEARCH_ATTR', 'sAMAccountName')
|
|
||||||
AUTH_LDAP_USER_SEARCH = LDAPSearch(AUTH_LDAP_USER_SEARCH_BASEDN,
|
|
||||||
ldap.SCOPE_SUBTREE,
|
|
||||||
"(" + AUTH_LDAP_USER_SEARCH_ATTR + "=%(user)s)")
|
|
||||||
|
|
||||||
# This search ought to return all groups to which the user belongs. django_auth_ldap uses this to determine group
|
|
||||||
# heirarchy.
|
|
||||||
AUTH_LDAP_GROUP_SEARCH_BASEDN = os.environ.get('AUTH_LDAP_GROUP_SEARCH_BASEDN', '')
|
|
||||||
AUTH_LDAP_GROUP_SEARCH_CLASS = os.environ.get('AUTH_LDAP_GROUP_SEARCH_CLASS', 'group')
|
|
||||||
AUTH_LDAP_GROUP_SEARCH = LDAPSearch(AUTH_LDAP_GROUP_SEARCH_BASEDN, ldap.SCOPE_SUBTREE,
|
|
||||||
"(objectClass=" + AUTH_LDAP_GROUP_SEARCH_CLASS + ")")
|
|
||||||
AUTH_LDAP_GROUP_TYPE = import_group_type(os.environ.get('AUTH_LDAP_GROUP_TYPE', 'GroupOfNamesType'))
|
|
||||||
|
|
||||||
# Define a group required to login.
|
|
||||||
AUTH_LDAP_REQUIRE_GROUP = os.environ.get('AUTH_LDAP_REQUIRE_GROUP_DN', '')
|
|
||||||
|
|
||||||
# Define special user types using groups. Exercise great caution when assigning superuser status.
|
|
||||||
AUTH_LDAP_USER_FLAGS_BY_GROUP = {
|
|
||||||
"is_active": os.environ.get('AUTH_LDAP_REQUIRE_GROUP_DN', ''),
|
|
||||||
"is_staff": os.environ.get('AUTH_LDAP_IS_ADMIN_DN', ''),
|
|
||||||
"is_superuser": os.environ.get('AUTH_LDAP_IS_SUPERUSER_DN', '')
|
|
||||||
}
|
|
||||||
|
|
||||||
# For more granular permissions, we can map LDAP groups to Django groups.
|
|
||||||
AUTH_LDAP_FIND_GROUP_PERMS = os.environ.get('AUTH_LDAP_FIND_GROUP_PERMS', 'True').lower() == 'true'
|
|
||||||
|
|
||||||
# Cache groups for one hour to reduce LDAP traffic
|
|
||||||
AUTH_LDAP_CACHE_GROUPS = os.environ.get('AUTH_LDAP_CACHE_GROUPS', 'True').lower() == 'true'
|
|
||||||
AUTH_LDAP_GROUP_CACHE_TIMEOUT = int(os.environ.get('AUTH_LDAP_GROUP_CACHE_TIMEOUT', 3600))
|
|
||||||
|
|
||||||
# Populate the Django user from the LDAP directory.
|
|
||||||
AUTH_LDAP_USER_ATTR_MAP = {
|
|
||||||
"first_name": os.environ.get('AUTH_LDAP_ATTR_FIRSTNAME', 'givenName'),
|
|
||||||
"last_name": os.environ.get('AUTH_LDAP_ATTR_LASTNAME', 'sn'),
|
|
||||||
"email": os.environ.get('AUTH_LDAP_ATTR_MAIL', 'mail')
|
|
||||||
}
|
|
|
@ -0,0 +1,55 @@
|
||||||
|
# # Remove first comment(#) on each line to implement this working logging example.
|
||||||
|
# # Add LOGLEVEL environment variable to netbox if you use this example & want a different log level.
|
||||||
|
# from os import environ
|
||||||
|
|
||||||
|
# # Set LOGLEVEL in netbox.env or docker-compose.overide.yml to override a logging level of INFO.
|
||||||
|
# LOGLEVEL = environ.get('LOGLEVEL', 'INFO')
|
||||||
|
|
||||||
|
# LOGGING = {
|
||||||
|
|
||||||
|
# 'version': 1,
|
||||||
|
# 'disable_existing_loggers': False,
|
||||||
|
# 'formatters': {
|
||||||
|
# 'verbose': {
|
||||||
|
# 'format': '{levelname} {asctime} {module} {process:d} {thread:d} {message}',
|
||||||
|
# 'style': '{',
|
||||||
|
# },
|
||||||
|
# 'simple': {
|
||||||
|
# 'format': '{levelname} {message}',
|
||||||
|
# 'style': '{',
|
||||||
|
# },
|
||||||
|
# },
|
||||||
|
# 'filters': {
|
||||||
|
# 'require_debug_false': {
|
||||||
|
# '()': 'django.utils.log.RequireDebugFalse',
|
||||||
|
# },
|
||||||
|
# },
|
||||||
|
# 'handlers': {
|
||||||
|
# 'console': {
|
||||||
|
# 'level': LOGLEVEL,
|
||||||
|
# 'filters': ['require_debug_false'],
|
||||||
|
# 'class': 'logging.StreamHandler',
|
||||||
|
# 'formatter': 'simple'
|
||||||
|
# },
|
||||||
|
# 'mail_admins': {
|
||||||
|
# 'level': 'ERROR',
|
||||||
|
# 'class': 'django.utils.log.AdminEmailHandler',
|
||||||
|
# 'filters': ['require_debug_false']
|
||||||
|
# }
|
||||||
|
# },
|
||||||
|
# 'loggers': {
|
||||||
|
# 'django': {
|
||||||
|
# 'handlers': ['console'],
|
||||||
|
# 'propagate': True,
|
||||||
|
# },
|
||||||
|
# 'django.request': {
|
||||||
|
# 'handlers': ['mail_admins'],
|
||||||
|
# 'level': 'ERROR',
|
||||||
|
# 'propagate': False,
|
||||||
|
# },
|
||||||
|
# 'django_auth_ldap': {
|
||||||
|
# 'handlers': ['console',],
|
||||||
|
# 'level': LOGLEVEL,
|
||||||
|
# }
|
||||||
|
# }
|
||||||
|
# }
|
|
@ -0,0 +1,13 @@
|
||||||
|
# Add your plugins and plugin settings here.
|
||||||
|
# Of course uncomment this file out.
|
||||||
|
|
||||||
|
# To learn how to build images with your required plugins
|
||||||
|
# See https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins
|
||||||
|
|
||||||
|
# PLUGINS = ["netbox_bgp"]
|
||||||
|
|
||||||
|
# PLUGINS_CONFIG = {
|
||||||
|
# "netbox_bgp": {
|
||||||
|
# ADD YOUR SETTINGS HERE
|
||||||
|
# }
|
||||||
|
# }
|
|
@ -0,0 +1,5 @@
|
||||||
|
version: '3.4'
|
||||||
|
services:
|
||||||
|
netbox:
|
||||||
|
ports:
|
||||||
|
- 127.0.0.1:44156:8080
|
|
@ -0,0 +1,5 @@
|
||||||
|
version: '3.4'
|
||||||
|
services:
|
||||||
|
netbox:
|
||||||
|
ports:
|
||||||
|
- 8000:8080
|
|
@ -3,43 +3,42 @@ services:
|
||||||
netbox:
|
netbox:
|
||||||
image: ${IMAGE-netboxcommunity/netbox:latest}
|
image: ${IMAGE-netboxcommunity/netbox:latest}
|
||||||
depends_on:
|
depends_on:
|
||||||
- postgres
|
postgres:
|
||||||
- redis
|
condition: service_healthy
|
||||||
|
redis:
|
||||||
|
condition: service_started
|
||||||
|
redis-cache:
|
||||||
|
condition: service_started
|
||||||
env_file: env/netbox.env
|
env_file: env/netbox.env
|
||||||
user: '101'
|
user: 'unit:root'
|
||||||
volumes:
|
volumes:
|
||||||
- ./startup_scripts:/opt/netbox/startup_scripts:z,ro
|
|
||||||
- ./${INITIALIZERS_DIR-initializers}:/opt/netbox/initializers:z,ro
|
|
||||||
- ./configuration:/etc/netbox/config:z,ro
|
- ./configuration:/etc/netbox/config:z,ro
|
||||||
|
- ./test-configuration/logging.py:/etc/netbox/config/logging.py:z,ro
|
||||||
- ./reports:/etc/netbox/reports:z,ro
|
- ./reports:/etc/netbox/reports:z,ro
|
||||||
- ./scripts:/etc/netbox/scripts:z,ro
|
- ./scripts:/etc/netbox/scripts:z,ro
|
||||||
- netbox-nginx-config:/etc/netbox-nginx:z
|
|
||||||
- netbox-static-files:/opt/netbox/netbox/static:z
|
|
||||||
- netbox-media-files:/opt/netbox/netbox/media:z
|
- netbox-media-files:/opt/netbox/netbox/media:z
|
||||||
nginx:
|
|
||||||
command: nginx -c /etc/netbox-nginx/nginx.conf
|
|
||||||
image: nginx:1.17-alpine
|
|
||||||
depends_on:
|
|
||||||
- netbox
|
|
||||||
ports:
|
|
||||||
- 8080
|
|
||||||
volumes:
|
|
||||||
- netbox-static-files:/opt/netbox/netbox/static:ro
|
|
||||||
- netbox-nginx-config:/etc/netbox-nginx/:ro
|
|
||||||
postgres:
|
postgres:
|
||||||
image: postgres:11-alpine
|
image: postgres:15-alpine
|
||||||
env_file: env/postgres.env
|
env_file: env/postgres.env
|
||||||
|
healthcheck:
|
||||||
|
test: ["CMD-SHELL", "pg_isready"]
|
||||||
|
interval: 10s
|
||||||
|
timeout: 5s
|
||||||
|
retries: 5
|
||||||
redis:
|
redis:
|
||||||
image: redis:5-alpine
|
image: redis:7-alpine
|
||||||
|
command:
|
||||||
|
- sh
|
||||||
|
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
||||||
|
- redis-server --appendonly yes --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
|
||||||
|
env_file: env/redis.env
|
||||||
|
redis-cache:
|
||||||
|
image: redis:7-alpine
|
||||||
command:
|
command:
|
||||||
- sh
|
- sh
|
||||||
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
||||||
- redis-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
|
- redis-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
|
||||||
env_file: env/redis.env
|
env_file: env/redis-cache.env
|
||||||
volumes:
|
volumes:
|
||||||
netbox-static-files:
|
|
||||||
driver: local
|
|
||||||
netbox-nginx-config:
|
|
||||||
driver: local
|
|
||||||
netbox-media-files:
|
netbox-media-files:
|
||||||
driver: local
|
driver: local
|
||||||
|
|
|
@ -1,49 +1,60 @@
|
||||||
version: '3.4'
|
version: '3.4'
|
||||||
services:
|
services:
|
||||||
netbox: &netbox
|
netbox: &netbox
|
||||||
image: netboxcommunity/netbox:${VERSION-latest}
|
image: netboxcommunity/netbox:${VERSION-v3.4-2.4.0}
|
||||||
depends_on:
|
depends_on:
|
||||||
- postgres
|
- postgres
|
||||||
- redis
|
- redis
|
||||||
- redis-cache
|
- redis-cache
|
||||||
- netbox-worker
|
|
||||||
env_file: env/netbox.env
|
env_file: env/netbox.env
|
||||||
user: '101'
|
user: 'unit:root'
|
||||||
|
healthcheck:
|
||||||
|
start_period: 60s
|
||||||
|
timeout: 3s
|
||||||
|
interval: 15s
|
||||||
|
test: "curl -f http://localhost:8080/api/ || exit 1"
|
||||||
volumes:
|
volumes:
|
||||||
- ./startup_scripts:/opt/netbox/startup_scripts:z,ro
|
|
||||||
- ./initializers:/opt/netbox/initializers:z,ro
|
|
||||||
- ./configuration:/etc/netbox/config:z,ro
|
- ./configuration:/etc/netbox/config:z,ro
|
||||||
- ./reports:/etc/netbox/reports:z,ro
|
- ./reports:/etc/netbox/reports:z,ro
|
||||||
- ./scripts:/etc/netbox/scripts:z,ro
|
- ./scripts:/etc/netbox/scripts:z,ro
|
||||||
- netbox-nginx-config:/etc/netbox-nginx:z
|
|
||||||
- netbox-static-files:/opt/netbox/netbox/static:z
|
|
||||||
- netbox-media-files:/opt/netbox/netbox/media:z
|
- netbox-media-files:/opt/netbox/netbox/media:z
|
||||||
netbox-worker:
|
netbox-worker:
|
||||||
<<: *netbox
|
<<: *netbox
|
||||||
depends_on:
|
depends_on:
|
||||||
- redis
|
netbox:
|
||||||
entrypoint:
|
condition: service_healthy
|
||||||
- python3
|
|
||||||
- /opt/netbox/netbox/manage.py
|
|
||||||
command:
|
command:
|
||||||
|
- /opt/netbox/venv/bin/python
|
||||||
|
- /opt/netbox/netbox/manage.py
|
||||||
- rqworker
|
- rqworker
|
||||||
nginx:
|
healthcheck:
|
||||||
command: nginx -c /etc/netbox-nginx/nginx.conf
|
start_period: 20s
|
||||||
image: nginx:1.17-alpine
|
timeout: 3s
|
||||||
|
interval: 15s
|
||||||
|
test: "ps -aux | grep -v grep | grep -q rqworker || exit 1"
|
||||||
|
netbox-housekeeping:
|
||||||
|
<<: *netbox
|
||||||
depends_on:
|
depends_on:
|
||||||
- netbox
|
netbox:
|
||||||
ports:
|
condition: service_healthy
|
||||||
- 8080
|
command:
|
||||||
volumes:
|
- /opt/netbox/housekeeping.sh
|
||||||
- netbox-static-files:/opt/netbox/netbox/static:ro
|
healthcheck:
|
||||||
- netbox-nginx-config:/etc/netbox-nginx/:ro
|
start_period: 20s
|
||||||
|
timeout: 3s
|
||||||
|
interval: 15s
|
||||||
|
test: "ps -aux | grep -v grep | grep -q housekeeping || exit 1"
|
||||||
|
|
||||||
|
# postgres
|
||||||
postgres:
|
postgres:
|
||||||
image: postgres:11-alpine
|
image: postgres:15-alpine
|
||||||
env_file: env/postgres.env
|
env_file: env/postgres.env
|
||||||
volumes:
|
volumes:
|
||||||
- netbox-postgres-data:/var/lib/postgresql/data
|
- netbox-postgres-data:/var/lib/postgresql/data
|
||||||
|
|
||||||
|
# redis
|
||||||
redis:
|
redis:
|
||||||
image: redis:5-alpine
|
image: redis:7-alpine
|
||||||
command:
|
command:
|
||||||
- sh
|
- sh
|
||||||
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
||||||
|
@ -52,20 +63,21 @@ services:
|
||||||
volumes:
|
volumes:
|
||||||
- netbox-redis-data:/data
|
- netbox-redis-data:/data
|
||||||
redis-cache:
|
redis-cache:
|
||||||
image: redis:5-alpine
|
image: redis:7-alpine
|
||||||
command:
|
command:
|
||||||
- sh
|
- sh
|
||||||
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
||||||
- redis-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
|
- redis-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
|
||||||
env_file: env/redis.env
|
env_file: env/redis-cache.env
|
||||||
|
volumes:
|
||||||
|
- netbox-redis-cache-data:/data
|
||||||
|
|
||||||
volumes:
|
volumes:
|
||||||
netbox-static-files:
|
|
||||||
driver: local
|
|
||||||
netbox-nginx-config:
|
|
||||||
driver: local
|
|
||||||
netbox-media-files:
|
netbox-media-files:
|
||||||
driver: local
|
driver: local
|
||||||
netbox-postgres-data:
|
netbox-postgres-data:
|
||||||
driver: local
|
driver: local
|
||||||
netbox-redis-data:
|
netbox-redis-data:
|
||||||
driver: local
|
driver: local
|
||||||
|
netbox-redis-cache-data:
|
||||||
|
driver: local
|
||||||
|
|
|
@ -1,10 +1,91 @@
|
||||||
|
## Generic Parts
|
||||||
|
# These functions are providing the functionality to load
|
||||||
|
# arbitrary configuration files.
|
||||||
|
#
|
||||||
|
# They can be imported by other code (see `ldap_config.py` for an example).
|
||||||
|
|
||||||
import importlib.util
|
import importlib.util
|
||||||
import sys
|
import sys
|
||||||
|
from os import scandir
|
||||||
|
from os.path import abspath, isfile
|
||||||
|
|
||||||
try:
|
|
||||||
spec = importlib.util.spec_from_file_location('configuration', '/etc/netbox/config/configuration.py')
|
def _filename(f):
|
||||||
module = importlib.util.module_from_spec(spec)
|
return f.name
|
||||||
spec.loader.exec_module(module)
|
|
||||||
sys.modules['netbox.configuration'] = module
|
|
||||||
except:
|
def _import(module_name, path, loaded_configurations):
|
||||||
raise ImportError('')
|
spec = importlib.util.spec_from_file_location("", path)
|
||||||
|
module = importlib.util.module_from_spec(spec)
|
||||||
|
spec.loader.exec_module(module)
|
||||||
|
sys.modules[module_name] = module
|
||||||
|
|
||||||
|
loaded_configurations.insert(0, module)
|
||||||
|
|
||||||
|
print(f"🧬 loaded config '{path}'")
|
||||||
|
|
||||||
|
|
||||||
|
def read_configurations(config_module, config_dir, main_config):
|
||||||
|
loaded_configurations = []
|
||||||
|
|
||||||
|
main_config_path = abspath(f"{config_dir}/{main_config}.py")
|
||||||
|
if isfile(main_config_path):
|
||||||
|
_import(f"{config_module}.{main_config}", main_config_path, loaded_configurations)
|
||||||
|
else:
|
||||||
|
print(f"⚠️ Main configuration '{main_config_path}' not found.")
|
||||||
|
|
||||||
|
with scandir(config_dir) as it:
|
||||||
|
for f in sorted(it, key=_filename):
|
||||||
|
if not f.is_file():
|
||||||
|
continue
|
||||||
|
|
||||||
|
if f.name.startswith("__"):
|
||||||
|
continue
|
||||||
|
|
||||||
|
if not f.name.endswith(".py"):
|
||||||
|
continue
|
||||||
|
|
||||||
|
if f.name == f"{main_config}.py":
|
||||||
|
continue
|
||||||
|
|
||||||
|
if f.name == f"{config_dir}.py":
|
||||||
|
continue
|
||||||
|
|
||||||
|
module_name = f"{config_module}.{f.name[:-len('.py')]}".replace(".", "_")
|
||||||
|
_import(module_name, f.path, loaded_configurations)
|
||||||
|
|
||||||
|
if len(loaded_configurations) == 0:
|
||||||
|
print(f"‼️ No configuration files found in '{config_dir}'.")
|
||||||
|
raise ImportError(f"No configuration files found in '{config_dir}'.")
|
||||||
|
|
||||||
|
return loaded_configurations
|
||||||
|
|
||||||
|
|
||||||
|
## Specific Parts
|
||||||
|
# This section's code actually loads the various configuration files
|
||||||
|
# into the module with the given name.
|
||||||
|
# It contains the logic to resolve arbitrary configuration options by
|
||||||
|
# levaraging dynamic programming using `__getattr__`.
|
||||||
|
|
||||||
|
|
||||||
|
_loaded_configurations = read_configurations(
|
||||||
|
config_dir="/etc/netbox/config/",
|
||||||
|
config_module="netbox.configuration",
|
||||||
|
main_config="configuration",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def __getattr__(name):
|
||||||
|
for config in _loaded_configurations:
|
||||||
|
try:
|
||||||
|
return getattr(config, name)
|
||||||
|
except:
|
||||||
|
pass
|
||||||
|
raise AttributeError
|
||||||
|
|
||||||
|
|
||||||
|
def __dir__():
|
||||||
|
names = []
|
||||||
|
for config in _loaded_configurations:
|
||||||
|
names.extend(config.__dir__())
|
||||||
|
return names
|
||||||
|
|
|
@ -1,25 +1,52 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# Runs on every start of the Netbox Docker container
|
# Runs on every start of the NetBox Docker container
|
||||||
|
|
||||||
# Stop when an error occures
|
# Stop when an error occures
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
# Allows Netbox to be run as non-root users
|
# Allows NetBox to be run as non-root users
|
||||||
umask 002
|
umask 002
|
||||||
|
|
||||||
|
# Load correct Python3 env
|
||||||
|
# shellcheck disable=SC1091
|
||||||
|
source /opt/netbox/venv/bin/activate
|
||||||
|
|
||||||
# Try to connect to the DB
|
# Try to connect to the DB
|
||||||
DB_WAIT_TIMEOUT=${DB_WAIT_TIMEOUT-3}
|
DB_WAIT_TIMEOUT=${DB_WAIT_TIMEOUT-3}
|
||||||
MAX_DB_WAIT_TIME=${MAX_DB_WAIT_TIME-30}
|
MAX_DB_WAIT_TIME=${MAX_DB_WAIT_TIME-30}
|
||||||
CUR_DB_WAIT_TIME=0
|
CUR_DB_WAIT_TIME=0
|
||||||
while ! ./manage.py migrate 2>&1 && [ "${CUR_DB_WAIT_TIME}" -lt "${MAX_DB_WAIT_TIME}" ]; do
|
while [ "${CUR_DB_WAIT_TIME}" -lt "${MAX_DB_WAIT_TIME}" ]; do
|
||||||
|
# Read and truncate connection error tracebacks to last line by default
|
||||||
|
exec {psfd}< <(./manage.py showmigrations 2>&1)
|
||||||
|
read -rd '' DB_ERR <&$psfd || :
|
||||||
|
exec {psfd}<&-
|
||||||
|
wait $! && break
|
||||||
|
if [ -n "$DB_WAIT_DEBUG" ]; then
|
||||||
|
echo "$DB_ERR"
|
||||||
|
else
|
||||||
|
readarray -tn 0 DB_ERR_LINES <<<"$DB_ERR"
|
||||||
|
echo "${DB_ERR_LINES[@]: -1}"
|
||||||
|
echo "[ Use DB_WAIT_DEBUG=1 in netbox.env to print full traceback for errors here ]"
|
||||||
|
fi
|
||||||
echo "⏳ Waiting on DB... (${CUR_DB_WAIT_TIME}s / ${MAX_DB_WAIT_TIME}s)"
|
echo "⏳ Waiting on DB... (${CUR_DB_WAIT_TIME}s / ${MAX_DB_WAIT_TIME}s)"
|
||||||
sleep "${DB_WAIT_TIMEOUT}"
|
sleep "${DB_WAIT_TIMEOUT}"
|
||||||
CUR_DB_WAIT_TIME=$(( CUR_DB_WAIT_TIME + DB_WAIT_TIMEOUT ))
|
CUR_DB_WAIT_TIME=$((CUR_DB_WAIT_TIME + DB_WAIT_TIMEOUT))
|
||||||
done
|
done
|
||||||
if [ "${CUR_DB_WAIT_TIME}" -ge "${MAX_DB_WAIT_TIME}" ]; then
|
if [ "${CUR_DB_WAIT_TIME}" -ge "${MAX_DB_WAIT_TIME}" ]; then
|
||||||
echo "❌ Waited ${MAX_DB_WAIT_TIME}s or more for the DB to become ready."
|
echo "❌ Waited ${MAX_DB_WAIT_TIME}s or more for the DB to become ready."
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
# Check if update is needed
|
||||||
|
if ! ./manage.py migrate --check >/dev/null 2>&1; then
|
||||||
|
echo "⚙️ Applying database migrations"
|
||||||
|
./manage.py migrate --no-input
|
||||||
|
echo "⚙️ Running trace_paths"
|
||||||
|
./manage.py trace_paths --no-input
|
||||||
|
echo "⚙️ Removing stale content types"
|
||||||
|
./manage.py remove_stale_contenttypes --no-input
|
||||||
|
echo "⚙️ Removing expired user sessions"
|
||||||
|
./manage.py clearsessions
|
||||||
|
fi
|
||||||
|
|
||||||
# Create Superuser if required
|
# Create Superuser if required
|
||||||
if [ "$SKIP_SUPERUSER" == "true" ]; then
|
if [ "$SKIP_SUPERUSER" == "true" ]; then
|
||||||
|
@ -31,22 +58,18 @@ else
|
||||||
if [ -z ${SUPERUSER_EMAIL+x} ]; then
|
if [ -z ${SUPERUSER_EMAIL+x} ]; then
|
||||||
SUPERUSER_EMAIL='admin@example.com'
|
SUPERUSER_EMAIL='admin@example.com'
|
||||||
fi
|
fi
|
||||||
if [ -z ${SUPERUSER_PASSWORD+x} ]; then
|
if [ -f "/run/secrets/superuser_password" ]; then
|
||||||
if [ -f "/run/secrets/superuser_password" ]; then
|
SUPERUSER_PASSWORD="$(</run/secrets/superuser_password)"
|
||||||
SUPERUSER_PASSWORD="$(< /run/secrets/superuser_password)"
|
elif [ -z ${SUPERUSER_PASSWORD+x} ]; then
|
||||||
else
|
SUPERUSER_PASSWORD='admin'
|
||||||
SUPERUSER_PASSWORD='admin'
|
|
||||||
fi
|
|
||||||
fi
|
fi
|
||||||
if [ -z ${SUPERUSER_API_TOKEN+x} ]; then
|
if [ -f "/run/secrets/superuser_api_token" ]; then
|
||||||
if [ -f "/run/secrets/superuser_api_token" ]; then
|
SUPERUSER_API_TOKEN="$(</run/secrets/superuser_api_token)"
|
||||||
SUPERUSER_API_TOKEN="$(< /run/secrets/superuser_api_token)"
|
elif [ -z ${SUPERUSER_API_TOKEN+x} ]; then
|
||||||
else
|
SUPERUSER_API_TOKEN='0123456789abcdef0123456789abcdef01234567'
|
||||||
SUPERUSER_API_TOKEN='0123456789abcdef0123456789abcdef01234567'
|
|
||||||
fi
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
./manage.py shell --interface python << END
|
./manage.py shell --interface python <<END
|
||||||
from django.contrib.auth.models import User
|
from django.contrib.auth.models import User
|
||||||
from users.models import Token
|
from users.models import Token
|
||||||
if not User.objects.filter(username='${SUPERUSER_NAME}'):
|
if not User.objects.filter(username='${SUPERUSER_NAME}'):
|
||||||
|
@ -57,20 +80,8 @@ END
|
||||||
echo "💡 Superuser Username: ${SUPERUSER_NAME}, E-Mail: ${SUPERUSER_EMAIL}"
|
echo "💡 Superuser Username: ${SUPERUSER_NAME}, E-Mail: ${SUPERUSER_EMAIL}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Run the startup scripts (and initializers)
|
|
||||||
if [ "$SKIP_STARTUP_SCRIPTS" == "true" ]; then
|
|
||||||
echo "↩️ Skipping startup scripts"
|
|
||||||
else
|
|
||||||
echo "import runpy; runpy.run_path('../startup_scripts')" | ./manage.py shell --interface python
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Copy static files
|
|
||||||
./manage.py collectstatic --no-input
|
|
||||||
|
|
||||||
echo "✅ Initialisation is done."
|
echo "✅ Initialisation is done."
|
||||||
|
|
||||||
# Launch whatever is passed by docker
|
# Launch whatever is passed by docker
|
||||||
# (i.e. the RUN instruction in the Dockerfile)
|
# (i.e. the RUN instruction in the Dockerfile)
|
||||||
#
|
exec "$@"
|
||||||
# shellcheck disable=SC2068
|
|
||||||
exec $@
|
|
||||||
|
|
|
@ -0,0 +1,8 @@
|
||||||
|
#!/bin/bash
|
||||||
|
SLEEP_SECONDS=${HOUSEKEEPING_INTERVAL:=86400}
|
||||||
|
echo "Interval set to ${SLEEP_SECONDS} seconds"
|
||||||
|
while true; do
|
||||||
|
date
|
||||||
|
/opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py housekeeping
|
||||||
|
sleep "${SLEEP_SECONDS}s"
|
||||||
|
done
|
|
@ -0,0 +1,56 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
UNIT_CONFIG="${UNIT_CONFIG-/etc/unit/nginx-unit.json}"
|
||||||
|
UNIT_SOCKET="/opt/unit/unit.sock"
|
||||||
|
|
||||||
|
load_configuration() {
|
||||||
|
MAX_WAIT=10
|
||||||
|
WAIT_COUNT=0
|
||||||
|
while [ ! -S $UNIT_SOCKET ]; do
|
||||||
|
if [ $WAIT_COUNT -ge $MAX_WAIT ]; then
|
||||||
|
echo "⚠️ No control socket found; configuration will not be loaded."
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
WAIT_COUNT=$((WAIT_COUNT + 1))
|
||||||
|
echo "⏳ Waiting for control socket to be created... (${WAIT_COUNT}/${MAX_WAIT})"
|
||||||
|
|
||||||
|
sleep 1
|
||||||
|
done
|
||||||
|
|
||||||
|
# even when the control socket exists, it does not mean unit has finished initialisation
|
||||||
|
# this curl call will get a reply once unit is fully launched
|
||||||
|
curl --silent --output /dev/null --request GET --unix-socket $UNIT_SOCKET http://localhost/
|
||||||
|
|
||||||
|
echo "⚙️ Applying configuration from $UNIT_CONFIG"
|
||||||
|
|
||||||
|
RESP_CODE=$(
|
||||||
|
curl \
|
||||||
|
--silent \
|
||||||
|
--output /dev/null \
|
||||||
|
--write-out '%{http_code}' \
|
||||||
|
--request PUT \
|
||||||
|
--data-binary "@${UNIT_CONFIG}" \
|
||||||
|
--unix-socket $UNIT_SOCKET \
|
||||||
|
http://localhost/config
|
||||||
|
)
|
||||||
|
if [ "$RESP_CODE" != "200" ]; then
|
||||||
|
echo "⚠️ Could no load Unit configuration"
|
||||||
|
kill "$(cat /opt/unit/unit.pid)"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "✅ Unit configuration loaded successfully"
|
||||||
|
}
|
||||||
|
|
||||||
|
load_configuration &
|
||||||
|
|
||||||
|
exec unitd \
|
||||||
|
--no-daemon \
|
||||||
|
--control unix:$UNIT_SOCKET \
|
||||||
|
--pid /opt/unit/unit.pid \
|
||||||
|
--log /dev/stdout \
|
||||||
|
--state /opt/unit/state/ \
|
||||||
|
--tmp /opt/unit/tmp/ \
|
||||||
|
--user unit \
|
||||||
|
--group root
|
|
@ -1,10 +1,23 @@
|
||||||
import importlib.util
|
from .configuration import read_configurations
|
||||||
import sys
|
|
||||||
|
|
||||||
try:
|
_loaded_configurations = read_configurations(
|
||||||
spec = importlib.util.spec_from_file_location('ldap_config', '/etc/netbox/config/ldap_config.py')
|
config_dir="/etc/netbox/config/ldap/",
|
||||||
module = importlib.util.module_from_spec(spec)
|
config_module="netbox.configuration.ldap",
|
||||||
spec.loader.exec_module(module)
|
main_config="ldap_config",
|
||||||
sys.modules['netbox.ldap_config'] = module
|
)
|
||||||
except:
|
|
||||||
raise ImportError('')
|
|
||||||
|
def __getattr__(name):
|
||||||
|
for config in _loaded_configurations:
|
||||||
|
try:
|
||||||
|
return getattr(config, name)
|
||||||
|
except:
|
||||||
|
pass
|
||||||
|
raise AttributeError
|
||||||
|
|
||||||
|
|
||||||
|
def __dir__():
|
||||||
|
names = []
|
||||||
|
for config in _loaded_configurations:
|
||||||
|
names.extend(config.__dir__())
|
||||||
|
return names
|
||||||
|
|
|
@ -0,0 +1,43 @@
|
||||||
|
{
|
||||||
|
"listeners": {
|
||||||
|
"0.0.0.0:8080": {
|
||||||
|
"pass": "routes"
|
||||||
|
},
|
||||||
|
"[::]:8080": {
|
||||||
|
"pass": "routes"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
"routes": [
|
||||||
|
{
|
||||||
|
"match": {
|
||||||
|
"uri": "/static/*"
|
||||||
|
},
|
||||||
|
"action": {
|
||||||
|
"share": "/opt/netbox/netbox${uri}"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
{
|
||||||
|
"action": {
|
||||||
|
"pass": "applications/netbox"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
|
||||||
|
"applications": {
|
||||||
|
"netbox": {
|
||||||
|
"type": "python 3",
|
||||||
|
"path": "/opt/netbox/netbox/",
|
||||||
|
"module": "netbox.wsgi",
|
||||||
|
"home": "/opt/netbox/venv",
|
||||||
|
"processes": {
|
||||||
|
"max": 4,
|
||||||
|
"spare": 1,
|
||||||
|
"idle_timeout": 120
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
"access_log": "/dev/stdout"
|
||||||
|
}
|
|
@ -1,36 +0,0 @@
|
||||||
daemon off;
|
|
||||||
worker_processes 1;
|
|
||||||
|
|
||||||
error_log /dev/stderr info;
|
|
||||||
|
|
||||||
events {
|
|
||||||
worker_connections 1024;
|
|
||||||
}
|
|
||||||
|
|
||||||
http {
|
|
||||||
include /etc/nginx/mime.types;
|
|
||||||
default_type application/octet-stream;
|
|
||||||
sendfile on;
|
|
||||||
tcp_nopush on;
|
|
||||||
keepalive_timeout 65;
|
|
||||||
gzip on;
|
|
||||||
server_tokens off;
|
|
||||||
client_max_body_size 10M;
|
|
||||||
|
|
||||||
server {
|
|
||||||
listen 8080;
|
|
||||||
access_log off;
|
|
||||||
|
|
||||||
location /static/ {
|
|
||||||
alias /opt/netbox/netbox/static/;
|
|
||||||
}
|
|
||||||
|
|
||||||
location / {
|
|
||||||
proxy_pass http://netbox:8001;
|
|
||||||
proxy_set_header X-Forwarded-Host $http_host;
|
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
|
||||||
proxy_set_header X-Forwarded-Proto $scheme;
|
|
||||||
add_header P3P 'CP="ALL DSP COR PSAa PSDa OUR NOR ONL UNI COM NAV"';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
|
@ -1,32 +1,38 @@
|
||||||
CORS_ORIGIN_ALLOW_ALL=True
|
CORS_ORIGIN_ALLOW_ALL=True
|
||||||
DB_NAME=netbox
|
|
||||||
DB_USER=netbox
|
|
||||||
DB_PASSWORD=J5brHrAXFLQSif0K
|
|
||||||
DB_HOST=postgres
|
DB_HOST=postgres
|
||||||
EMAIL_SERVER=localhost
|
DB_NAME=netbox
|
||||||
EMAIL_PORT=25
|
DB_PASSWORD=J5brHrAXFLQSif0K
|
||||||
EMAIL_USERNAME=netbox
|
DB_USER=netbox
|
||||||
EMAIL_PASSWORD=
|
|
||||||
EMAIL_TIMEOUT=5
|
|
||||||
EMAIL_FROM=netbox@bar.com
|
EMAIL_FROM=netbox@bar.com
|
||||||
|
EMAIL_PASSWORD=
|
||||||
|
EMAIL_PORT=25
|
||||||
|
EMAIL_SERVER=localhost
|
||||||
|
EMAIL_SSL_CERTFILE=
|
||||||
|
EMAIL_SSL_KEYFILE=
|
||||||
|
EMAIL_TIMEOUT=5
|
||||||
|
EMAIL_USERNAME=netbox
|
||||||
|
# EMAIL_USE_SSL and EMAIL_USE_TLS are mutually exclusive, i.e. they can't both be `true`!
|
||||||
|
EMAIL_USE_SSL=false
|
||||||
|
EMAIL_USE_TLS=false
|
||||||
|
GRAPHQL_ENABLED=true
|
||||||
|
HOUSEKEEPING_INTERVAL=86400
|
||||||
MEDIA_ROOT=/opt/netbox/netbox/media
|
MEDIA_ROOT=/opt/netbox/netbox/media
|
||||||
NAPALM_USERNAME=
|
METRICS_ENABLED=false
|
||||||
NAPALM_PASSWORD=
|
REDIS_CACHE_DATABASE=1
|
||||||
NAPALM_TIMEOUT=10
|
|
||||||
MAX_PAGE_SIZE=1000
|
|
||||||
REDIS_HOST=redis
|
|
||||||
REDIS_PASSWORD=H733Kdjndks81
|
|
||||||
REDIS_DATABASE=0
|
|
||||||
REDIS_SSL=false
|
|
||||||
REDIS_CACHE_HOST=redis-cache
|
REDIS_CACHE_HOST=redis-cache
|
||||||
|
REDIS_CACHE_INSECURE_SKIP_TLS_VERIFY=false
|
||||||
REDIS_CACHE_PASSWORD=t4Ph722qJ5QHeQ1qfu36
|
REDIS_CACHE_PASSWORD=t4Ph722qJ5QHeQ1qfu36
|
||||||
REDIS_CACHE_DATABASE=0
|
|
||||||
REDIS_CACHE_SSL=false
|
REDIS_CACHE_SSL=false
|
||||||
|
REDIS_DATABASE=0
|
||||||
|
REDIS_HOST=redis
|
||||||
|
REDIS_INSECURE_SKIP_TLS_VERIFY=false
|
||||||
|
REDIS_PASSWORD=H733Kdjndks81
|
||||||
|
REDIS_SSL=false
|
||||||
|
RELEASE_CHECK_URL=https://api.github.com/repos/netbox-community/netbox/releases
|
||||||
SECRET_KEY=r8OwDznj!!dci#P9ghmRfdu1Ysxm0AiPeDCQhKE+N_rClfWNj
|
SECRET_KEY=r8OwDznj!!dci#P9ghmRfdu1Ysxm0AiPeDCQhKE+N_rClfWNj
|
||||||
SKIP_STARTUP_SCRIPTS=false
|
|
||||||
SKIP_SUPERUSER=false
|
SKIP_SUPERUSER=false
|
||||||
SUPERUSER_NAME=admin
|
|
||||||
SUPERUSER_EMAIL=admin@example.com
|
|
||||||
SUPERUSER_PASSWORD=admin
|
|
||||||
SUPERUSER_API_TOKEN=0123456789abcdef0123456789abcdef01234567
|
SUPERUSER_API_TOKEN=0123456789abcdef0123456789abcdef01234567
|
||||||
|
SUPERUSER_EMAIL=admin@example.com
|
||||||
|
SUPERUSER_NAME=admin
|
||||||
|
SUPERUSER_PASSWORD=admin
|
||||||
WEBHOOKS_ENABLED=true
|
WEBHOOKS_ENABLED=true
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
POSTGRES_USER=netbox
|
|
||||||
POSTGRES_PASSWORD=J5brHrAXFLQSif0K
|
|
||||||
POSTGRES_DB=netbox
|
POSTGRES_DB=netbox
|
||||||
|
POSTGRES_PASSWORD=J5brHrAXFLQSif0K
|
||||||
|
POSTGRES_USER=netbox
|
||||||
|
|
|
@ -1,6 +0,0 @@
|
||||||
# - prefix: 10.0.0.0/16
|
|
||||||
# rir: RFC1918
|
|
||||||
# - prefix: fd00:ccdd::/32
|
|
||||||
# rir: RFC4193 ULA
|
|
||||||
# - prefix: 2001:db8::/32
|
|
||||||
# rir: RFC3849
|
|
|
@ -1,2 +0,0 @@
|
||||||
# - name: Hyper-V
|
|
||||||
# slug: hyper-v
|
|
|
@ -1,5 +0,0 @@
|
||||||
# - name: cluster1
|
|
||||||
# type: Hyper-V
|
|
||||||
# - name: cluster2
|
|
||||||
# type: Hyper-V
|
|
||||||
# site: SING 1
|
|
|
@ -1,97 +0,0 @@
|
||||||
## Possible Choices:
|
|
||||||
## type:
|
|
||||||
## - text
|
|
||||||
## - integer
|
|
||||||
## - boolean
|
|
||||||
## - date
|
|
||||||
## - url
|
|
||||||
## - select
|
|
||||||
## filter_logic:
|
|
||||||
## - disabled
|
|
||||||
## - loose
|
|
||||||
## - exact
|
|
||||||
##
|
|
||||||
## Examples:
|
|
||||||
|
|
||||||
# text_field:
|
|
||||||
# type: text
|
|
||||||
# label: Custom Text
|
|
||||||
# description: Enter text in a text field.
|
|
||||||
# required: false
|
|
||||||
# weight: 0
|
|
||||||
# on_objects:
|
|
||||||
# - dcim.models.Device
|
|
||||||
# - dcim.models.Rack
|
|
||||||
# - dcim.models.Site
|
|
||||||
# - dcim.models.DeviceType
|
|
||||||
# - ipam.models.IPAddress
|
|
||||||
# - ipam.models.Prefix
|
|
||||||
# - tenancy.models.Tenant
|
|
||||||
# - virtualization.models.VirtualMachine
|
|
||||||
# integer_field:
|
|
||||||
# type: integer
|
|
||||||
# label: Custom Number
|
|
||||||
# description: Enter numbers into an integer field.
|
|
||||||
# required: true
|
|
||||||
# filter_logic: loose
|
|
||||||
# weight: 10
|
|
||||||
# on_objects:
|
|
||||||
# - tenancy.models.Tenant
|
|
||||||
# select_field:
|
|
||||||
# type: select
|
|
||||||
# label: Choose between items
|
|
||||||
# required: false
|
|
||||||
# filter_logic: exact
|
|
||||||
# weight: 30
|
|
||||||
# on_objects:
|
|
||||||
# - dcim.models.Device
|
|
||||||
# choices:
|
|
||||||
# - value: First Item
|
|
||||||
# weight: 10
|
|
||||||
# - value: Second Item
|
|
||||||
# weight: 20
|
|
||||||
# - value: Third Item
|
|
||||||
# weight: 30
|
|
||||||
# - value: Fifth Item
|
|
||||||
# weight: 50
|
|
||||||
# - value: Fourth Item
|
|
||||||
# weight: 40
|
|
||||||
# select_field_auto_weight:
|
|
||||||
# type: select
|
|
||||||
# label: Choose between items
|
|
||||||
# required: false
|
|
||||||
# filter_logic: loose
|
|
||||||
# weight: 30
|
|
||||||
# on_objects:
|
|
||||||
# - dcim.models.Device
|
|
||||||
# choices:
|
|
||||||
# - value: A
|
|
||||||
# - value: B
|
|
||||||
# - value: C
|
|
||||||
# - value: "D like deprecated"
|
|
||||||
# weight: 999
|
|
||||||
# - value: E
|
|
||||||
# boolean_field:
|
|
||||||
# type: boolean
|
|
||||||
# label: Yes Or No?
|
|
||||||
# required: true
|
|
||||||
# filter_logic: loose
|
|
||||||
# default: "false" # important: but "false" in quotes!
|
|
||||||
# weight: 90
|
|
||||||
# on_objects:
|
|
||||||
# - dcim.models.Device
|
|
||||||
# url_field:
|
|
||||||
# type: url
|
|
||||||
# label: Hyperlink
|
|
||||||
# description: Link to something nice.
|
|
||||||
# required: true
|
|
||||||
# filter_logic: disabled
|
|
||||||
# on_objects:
|
|
||||||
# - tenancy.models.Tenant
|
|
||||||
# date_field:
|
|
||||||
# type: date
|
|
||||||
# label: Important Date
|
|
||||||
# required: false
|
|
||||||
# filter_logic: disabled
|
|
||||||
# on_objects:
|
|
||||||
# - dcim.models.Device
|
|
|
@ -1,18 +0,0 @@
|
||||||
## Possible Choices:
|
|
||||||
## type:
|
|
||||||
## - virtual
|
|
||||||
## - lag
|
|
||||||
## - 1000base-t
|
|
||||||
## - ... and many more. See for yourself:
|
|
||||||
## https://github.com/netbox-community/netbox/blob/295d4f0394b431351c0cb2c3ecc791df68c6c2fb/netbox/dcim/choices.py#L510
|
|
||||||
##
|
|
||||||
## Examples:
|
|
||||||
|
|
||||||
# - device: server01
|
|
||||||
# enabled: true
|
|
||||||
# type: virtual
|
|
||||||
# name: to-server02
|
|
||||||
# - device: server02
|
|
||||||
# enabled: true
|
|
||||||
# type: virtual
|
|
||||||
# name: to-server01
|
|
|
@ -1,15 +0,0 @@
|
||||||
# - name: switch
|
|
||||||
# slug: switch
|
|
||||||
# color: Grey
|
|
||||||
# - name: router
|
|
||||||
# slug: router
|
|
||||||
# color: Cyan
|
|
||||||
# - name: load-balancer
|
|
||||||
# slug: load-balancer
|
|
||||||
# color: Red
|
|
||||||
# - name: server
|
|
||||||
# slug: server
|
|
||||||
# color: Blue
|
|
||||||
# - name: patchpanel
|
|
||||||
# slug: patchpanel
|
|
||||||
# color: Black
|
|
|
@ -1,23 +0,0 @@
|
||||||
# - model: Model 1
|
|
||||||
# manufacturer: Manufacturer 1
|
|
||||||
# slug: model-1
|
|
||||||
# u_height: 2
|
|
||||||
# custom_fields:
|
|
||||||
# text_field: Description
|
|
||||||
# - model: Model 2
|
|
||||||
# manufacturer: Manufacturer 1
|
|
||||||
# slug: model-2
|
|
||||||
# custom_fields:
|
|
||||||
# text_field: Description
|
|
||||||
# - model: Model 3
|
|
||||||
# manufacturer: Manufacturer 1
|
|
||||||
# slug: model-3
|
|
||||||
# is_full_depth: false
|
|
||||||
# u_height: 0
|
|
||||||
# custom_fields:
|
|
||||||
# text_field: Description
|
|
||||||
# - model: Other
|
|
||||||
# manufacturer: No Name
|
|
||||||
# slug: other
|
|
||||||
# custom_fields:
|
|
||||||
# text_field: Description
|
|
|
@ -1,42 +0,0 @@
|
||||||
## Possible Choices:
|
|
||||||
## face:
|
|
||||||
## - front
|
|
||||||
## - rear
|
|
||||||
## status:
|
|
||||||
## - offline
|
|
||||||
## - active
|
|
||||||
## - planned
|
|
||||||
## - staged
|
|
||||||
## - failed
|
|
||||||
## - inventory
|
|
||||||
## - decommissioning
|
|
||||||
##
|
|
||||||
## Examples:
|
|
||||||
|
|
||||||
# - name: server01
|
|
||||||
# device_role: server
|
|
||||||
# device_type: Other
|
|
||||||
# site: AMS 1
|
|
||||||
# rack: rack-01
|
|
||||||
# face: front
|
|
||||||
# position: 1
|
|
||||||
# custom_fields:
|
|
||||||
# text_field: Description
|
|
||||||
# - name: server02
|
|
||||||
# device_role: server
|
|
||||||
# device_type: Other
|
|
||||||
# site: AMS 2
|
|
||||||
# rack: rack-02
|
|
||||||
# face: front
|
|
||||||
# position: 2
|
|
||||||
# custom_fields:
|
|
||||||
# text_field: Description
|
|
||||||
# - name: server03
|
|
||||||
# device_role: server
|
|
||||||
# device_type: Other
|
|
||||||
# site: SING 1
|
|
||||||
# rack: rack-03
|
|
||||||
# face: front
|
|
||||||
# position: 3
|
|
||||||
# custom_fields:
|
|
||||||
# text_field: Description
|
|
|
@ -1,16 +0,0 @@
|
||||||
# applications:
|
|
||||||
# users:
|
|
||||||
# - technical_user
|
|
||||||
# readers:
|
|
||||||
# users:
|
|
||||||
# - reader
|
|
||||||
# writers:
|
|
||||||
# users:
|
|
||||||
# - writer
|
|
||||||
# permissions:
|
|
||||||
# - add_device
|
|
||||||
# - change_device
|
|
||||||
# - delete_device
|
|
||||||
# - add_virtualmachine
|
|
||||||
# - change_virtualmachine
|
|
||||||
# - delete_virtualmachine
|
|
|
@ -1,44 +0,0 @@
|
||||||
## Possible Choices:
|
|
||||||
## status:
|
|
||||||
## - active
|
|
||||||
## - reserved
|
|
||||||
## - deprecated
|
|
||||||
## - dhcp
|
|
||||||
## role:
|
|
||||||
## - loopback
|
|
||||||
## - secondary
|
|
||||||
## - anycast
|
|
||||||
## - vip
|
|
||||||
## - vrrp
|
|
||||||
## - hsrp
|
|
||||||
## - glbp
|
|
||||||
## - carp
|
|
||||||
##
|
|
||||||
## Examples:
|
|
||||||
|
|
||||||
# - address: 10.1.1.1/24
|
|
||||||
# device: server01
|
|
||||||
# interface: to-server02
|
|
||||||
# status: active
|
|
||||||
# vrf: vrf1
|
|
||||||
# - address: 2001:db8:a000:1::1/64
|
|
||||||
# device: server01
|
|
||||||
# interface: to-server02
|
|
||||||
# status: active
|
|
||||||
# vrf: vrf1
|
|
||||||
# - address: 10.1.1.2/24
|
|
||||||
# device: server02
|
|
||||||
# interface: to-server01
|
|
||||||
# status: active
|
|
||||||
# - address: 2001:db8:a000:1::2/64
|
|
||||||
# device: server02
|
|
||||||
# interface: to-server01
|
|
||||||
# status: active
|
|
||||||
# - address: 10.1.1.10/24
|
|
||||||
# description: reserved IP
|
|
||||||
# status: reserved
|
|
||||||
# tenant: tenant1
|
|
||||||
# - address: 2001:db8:a000:1::10/64
|
|
||||||
# description: reserved IP
|
|
||||||
# status: reserved
|
|
||||||
# tenant: tenant1
|
|
|
@ -1,6 +0,0 @@
|
||||||
# - name: Manufacturer 1
|
|
||||||
# slug: manufacturer-1
|
|
||||||
# - name: Manufacturer 2
|
|
||||||
# slug: manufacturer-2
|
|
||||||
# - name: No Name
|
|
||||||
# slug: no-name
|
|
|
@ -1,15 +0,0 @@
|
||||||
# - name: Platform 1
|
|
||||||
# slug: platform-1
|
|
||||||
# manufacturer: Manufacturer 1
|
|
||||||
# napalm_driver: driver1
|
|
||||||
# napalm_args: "{'arg1': 'value1', 'arg2': 'value2'}"
|
|
||||||
# - name: Platform 2
|
|
||||||
# slug: platform-2
|
|
||||||
# manufacturer: Manufacturer 2
|
|
||||||
# napalm_driver: driver2
|
|
||||||
# napalm_args: "{'arg1': 'value1', 'arg2': 'value2'}"
|
|
||||||
# - name: Platform 3
|
|
||||||
# slug: platform-3
|
|
||||||
# manufacturer: No Name
|
|
||||||
# napalm_driver: driver3
|
|
||||||
# napalm_args: "{'arg1': 'value1', 'arg2': 'value2'}"
|
|
|
@ -1,2 +0,0 @@
|
||||||
# - name: Main Management
|
|
||||||
# slug: main-management
|
|
|
@ -1,29 +0,0 @@
|
||||||
## Possible Choices:
|
|
||||||
## status:
|
|
||||||
## - container
|
|
||||||
## - active
|
|
||||||
## - reserved
|
|
||||||
## - deprecated
|
|
||||||
##
|
|
||||||
## Examples:
|
|
||||||
|
|
||||||
# - description: prefix1
|
|
||||||
# prefix: 10.1.1.0/24
|
|
||||||
# site: AMS 1
|
|
||||||
# status: active
|
|
||||||
# tenant: tenant1
|
|
||||||
# vlan: vlan1
|
|
||||||
# - description: prefix2
|
|
||||||
# prefix: 10.1.2.0/24
|
|
||||||
# site: AMS 2
|
|
||||||
# status: active
|
|
||||||
# tenant: tenant2
|
|
||||||
# vlan: vlan2
|
|
||||||
# is_pool: true
|
|
||||||
# vrf: vrf2
|
|
||||||
# - description: ipv6 prefix1
|
|
||||||
# prefix: 2001:db8:a000:1::/64
|
|
||||||
# site: AMS 2
|
|
||||||
# status: active
|
|
||||||
# tenant: tenant2
|
|
||||||
# vlan: vlan2
|
|
|
@ -1,3 +0,0 @@
|
||||||
# - name: cage 101
|
|
||||||
# slug: cage-101
|
|
||||||
# site: SING 1
|
|
|
@ -1,12 +0,0 @@
|
||||||
# - name: Role 1
|
|
||||||
# slug: role-1
|
|
||||||
# color: Pink
|
|
||||||
# - name: Role 2
|
|
||||||
# slug: role-2
|
|
||||||
# color: Cyan
|
|
||||||
# - name: Role 3
|
|
||||||
# slug: role-3
|
|
||||||
# color: Grey
|
|
||||||
# - name: Role 4
|
|
||||||
# slug: role-4
|
|
||||||
# color: Teal
|
|
|
@ -1,41 +0,0 @@
|
||||||
## Possible Choices:
|
|
||||||
## width:
|
|
||||||
## - 19
|
|
||||||
## - 23
|
|
||||||
## types:
|
|
||||||
## - 2-post-frame
|
|
||||||
## - 4-post-frame
|
|
||||||
## - 4-post-cabinet
|
|
||||||
## - wall-frame
|
|
||||||
## - wall-cabinet
|
|
||||||
## outer_unit:
|
|
||||||
## - mm
|
|
||||||
## - in
|
|
||||||
##
|
|
||||||
## Examples:
|
|
||||||
|
|
||||||
# - site: AMS 1
|
|
||||||
# name: rack-01
|
|
||||||
# role: Role 1
|
|
||||||
# type: 4-post-cabinet
|
|
||||||
# width: 19
|
|
||||||
# u_height: 47
|
|
||||||
# custom_fields:
|
|
||||||
# text_field: Description
|
|
||||||
# - site: AMS 2
|
|
||||||
# name: rack-02
|
|
||||||
# role: Role 2
|
|
||||||
# type: 4-post-cabinet
|
|
||||||
# width: 19
|
|
||||||
# u_height: 47
|
|
||||||
# custom_fields:
|
|
||||||
# text_field: Description
|
|
||||||
# - site: SING 1
|
|
||||||
# name: rack-03
|
|
||||||
# group: cage 101
|
|
||||||
# role: Role 3
|
|
||||||
# type: 4-post-cabinet
|
|
||||||
# width: 19
|
|
||||||
# u_height: 47
|
|
||||||
# custom_fields:
|
|
||||||
# text_field: Description
|
|
|
@ -1,10 +0,0 @@
|
||||||
# - name: Singapore
|
|
||||||
# slug: singapore
|
|
||||||
# - name: Amsterdam
|
|
||||||
# slug: amsterdam
|
|
||||||
# - name: Downtown
|
|
||||||
# slug: downtown
|
|
||||||
# parent: Amsterdam
|
|
||||||
# - name: Suburbs
|
|
||||||
# slug: suburbs
|
|
||||||
# parent: Amsterdam
|
|
|
@ -1,9 +0,0 @@
|
||||||
# - is_private: true
|
|
||||||
# name: RFC1918
|
|
||||||
# slug: rfc1918
|
|
||||||
# - is_private: true
|
|
||||||
# name: RFC4193 ULA
|
|
||||||
# slug: rfc4193-ula
|
|
||||||
# - is_private: true
|
|
||||||
# name: RFC3849
|
|
||||||
# slug: rfc3849
|
|
|
@ -1,32 +0,0 @@
|
||||||
# - name: AMS 1
|
|
||||||
# slug: ams1
|
|
||||||
# region: Downtown
|
|
||||||
# status: 1
|
|
||||||
# facility: Amsterdam 1
|
|
||||||
# asn: 12345
|
|
||||||
# custom_fields:
|
|
||||||
# text_field: Description
|
|
||||||
# - name: AMS 2
|
|
||||||
# slug: ams2
|
|
||||||
# region: Downtown
|
|
||||||
# status: 1
|
|
||||||
# facility: Amsterdam 2
|
|
||||||
# asn: 54321
|
|
||||||
# custom_fields:
|
|
||||||
# text_field: Description
|
|
||||||
# - name: AMS 3
|
|
||||||
# slug: ams3
|
|
||||||
# region: Suburbs
|
|
||||||
# status: 1
|
|
||||||
# facility: Amsterdam 3
|
|
||||||
# asn: 67890
|
|
||||||
# custom_fields:
|
|
||||||
# text_field: Description
|
|
||||||
# - name: SING 1
|
|
||||||
# slug: sing1
|
|
||||||
# region: Singapore
|
|
||||||
# status: 1
|
|
||||||
# facility: Singapore 1
|
|
||||||
# asn: 09876
|
|
||||||
# custom_fields:
|
|
||||||
# text_field: Description
|
|
|
@ -1,4 +0,0 @@
|
||||||
# - name: Tenant Group 1
|
|
||||||
# slug: tenant-group-1
|
|
||||||
# - name: Tenant Group 2
|
|
||||||
# slug: tenant-group-2
|
|
|
@ -1,5 +0,0 @@
|
||||||
# - name: tenant1
|
|
||||||
# slug: tenant1
|
|
||||||
# - name: tenant2
|
|
||||||
# slug: tenant2
|
|
||||||
# group: Tenant Group 2
|
|
|
@ -1,13 +0,0 @@
|
||||||
# technical_user:
|
|
||||||
# api_token: 0123456789technicaluser789abcdef01234567 # must be looooong!
|
|
||||||
# reader:
|
|
||||||
# password: reader
|
|
||||||
# writer:
|
|
||||||
# password: writer
|
|
||||||
# permissions:
|
|
||||||
# - add_device
|
|
||||||
# - change_device
|
|
||||||
# - delete_device
|
|
||||||
# - add_virtualmachine
|
|
||||||
# - change_virtualmachine
|
|
||||||
# - delete_virtualmachine
|
|
|
@ -1,26 +0,0 @@
|
||||||
## Possible Choices:
|
|
||||||
## status:
|
|
||||||
## - active
|
|
||||||
## - offline
|
|
||||||
## - staged
|
|
||||||
##
|
|
||||||
## Examples:
|
|
||||||
|
|
||||||
# - cluster: cluster1
|
|
||||||
# comments: VM1
|
|
||||||
# disk: 200
|
|
||||||
# memory: 4096
|
|
||||||
# name: virtual machine 1
|
|
||||||
# platform: Platform 2
|
|
||||||
# status: active
|
|
||||||
# tenant: tenant1
|
|
||||||
# vcpus: 8
|
|
||||||
# - cluster: cluster1
|
|
||||||
# comments: VM2
|
|
||||||
# disk: 100
|
|
||||||
# memory: 2048
|
|
||||||
# name: virtual machine 2
|
|
||||||
# platform: Platform 2
|
|
||||||
# status: active
|
|
||||||
# tenant: tenant1
|
|
||||||
# vcpus: 8
|
|
|
@ -1,12 +0,0 @@
|
||||||
# - description: Network Interface 1
|
|
||||||
# enabled: true
|
|
||||||
# mac_address: 00:77:77:77:77:77
|
|
||||||
# mtu: 1500
|
|
||||||
# name: Network Interface 1
|
|
||||||
# virtual_machine: virtual machine 1
|
|
||||||
# - description: Network Interface 2
|
|
||||||
# enabled: true
|
|
||||||
# mac_address: 00:55:55:55:55:55
|
|
||||||
# mtu: 1500
|
|
||||||
# name: Network Interface 2
|
|
||||||
# virtual_machine: virtual machine 1
|
|
|
@ -1,6 +0,0 @@
|
||||||
# - name: VLAN group 1
|
|
||||||
# site: AMS 1
|
|
||||||
# slug: vlan-group-1
|
|
||||||
# - name: VLAN group 2
|
|
||||||
# site: AMS 1
|
|
||||||
# slug: vlan-group-2
|
|
|
@ -1,19 +0,0 @@
|
||||||
## Possible Choices:
|
|
||||||
## status:
|
|
||||||
## - active
|
|
||||||
## - reserved
|
|
||||||
## - deprecated
|
|
||||||
##
|
|
||||||
## Examples:
|
|
||||||
|
|
||||||
# - name: vlan1
|
|
||||||
# site: AMS 1
|
|
||||||
# status: active
|
|
||||||
# vid: 5
|
|
||||||
# role: Main Management
|
|
||||||
# description: VLAN 5 for MGMT
|
|
||||||
# - group: VLAN group 2
|
|
||||||
# name: vlan2
|
|
||||||
# site: AMS 1
|
|
||||||
# status: active
|
|
||||||
# vid: 1300
|
|
|
@ -1,8 +0,0 @@
|
||||||
# - enforce_unique: true
|
|
||||||
# name: vrf1
|
|
||||||
# tenant: tenant1
|
|
||||||
# description: main VRF
|
|
||||||
# - enforce_unique: true
|
|
||||||
# name: vrf2
|
|
||||||
# rd: "6500:6500"
|
|
||||||
# tenant: tenant2
|
|
|
@ -0,0 +1,26 @@
|
||||||
|
[tool.black]
|
||||||
|
line_length = 100
|
||||||
|
target-version = ['py38']
|
||||||
|
include = '\.pyi?$'
|
||||||
|
exclude = '''
|
||||||
|
(
|
||||||
|
/(
|
||||||
|
\.git
|
||||||
|
| \.venv
|
||||||
|
| \.netbox
|
||||||
|
| \.vscode
|
||||||
|
| configuration
|
||||||
|
)/
|
||||||
|
)
|
||||||
|
'''
|
||||||
|
|
||||||
|
[tool.isort]
|
||||||
|
profile = "black"
|
||||||
|
multi_line_output = 3
|
||||||
|
line_length = 100
|
||||||
|
|
||||||
|
[tool.pylint.messages_control]
|
||||||
|
disable = "C0330, C0326"
|
||||||
|
|
||||||
|
[tool.pylint.format]
|
||||||
|
max-line-length = "100"
|
|
@ -0,0 +1,188 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
DEFAULT_REPO=netbox-community/netbox-docker
|
||||||
|
REPO="${REPO-${DEFAULT_REPO}}"
|
||||||
|
|
||||||
|
echomoji() {
|
||||||
|
EMOJI=${1}
|
||||||
|
TEXT=${2}
|
||||||
|
shift 2
|
||||||
|
if [ -z "$DISABLE_EMOJI" ]; then
|
||||||
|
echo "${EMOJI}" "${@}"
|
||||||
|
else
|
||||||
|
echo "${TEXT}" "${@}"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
echo_nok() {
|
||||||
|
echomoji "❌" "!" "${@}"
|
||||||
|
}
|
||||||
|
echo_ok() {
|
||||||
|
echomoji "✅" "-" "${@}"
|
||||||
|
}
|
||||||
|
echo_hint() {
|
||||||
|
echomoji "👉" ">" "${@}"
|
||||||
|
}
|
||||||
|
|
||||||
|
# check errors shall exit with code 1
|
||||||
|
|
||||||
|
check_clean_repo() {
|
||||||
|
changes=$(git status --porcelain 2>/dev/null)
|
||||||
|
if [ ${?} ] && [ -n "$changes" ]; then
|
||||||
|
echo_nok "There are git changes pending:"
|
||||||
|
echo "$changes"
|
||||||
|
echo_hint "Please clean the repository before continueing: git stash --include-untracked"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo_ok "Repository has no pending changes."
|
||||||
|
}
|
||||||
|
|
||||||
|
check_branch() {
|
||||||
|
expected_branch="${1}"
|
||||||
|
actual_branch=$(git rev-parse --abbrev-ref HEAD 2>/dev/null)
|
||||||
|
if [ ${?} ] && [ "${actual_branch}" != "${expected_branch}" ]; then
|
||||||
|
echo_nok "Current branch should be '${expected_branch}', but is '${actual_branch}'."
|
||||||
|
echo_hint "Please change to the '${expected_branch}' branch: git checkout ${expected_branch}"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo_ok "The current branch is '${actual_branch}'."
|
||||||
|
}
|
||||||
|
|
||||||
|
check_upstream() {
|
||||||
|
expected_upstream_branch="origin/${1}"
|
||||||
|
actual_upstream_branch=$(git rev-parse --abbrev-ref '@{upstream}' 2>/dev/null)
|
||||||
|
if [ ${?} ] && [ "${actual_upstream_branch}" != "${expected_upstream_branch}" ]; then
|
||||||
|
echo_nok "Current upstream branch should be '${expected_upstream_branch}', but is '${actual_upstream_branch}'."
|
||||||
|
echo_hint "Please set '${expected_upstream_branch}' as the upstream branch: git branch --set-upstream-to=${expected_upstream_branch}"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo_ok "The current upstream branch is '${actual_upstream_branch}'."
|
||||||
|
}
|
||||||
|
|
||||||
|
check_origin() {
|
||||||
|
expected_origin="git@github.com:${REPO}.git"
|
||||||
|
actual_origin=$(git remote get-url origin 2>/dev/null)
|
||||||
|
if [ ${?} ] && [ "${actual_origin}" != "${expected_origin}" ]; then
|
||||||
|
echo_nok "The url of origin is '${actual_origin}', but '${expected_origin}' is expected."
|
||||||
|
echo_hint "Please set '${expected_origin}' as the url for origin: git origin set-url '${expected_origin}'"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo_ok "The current origin url is '${actual_origin}'."
|
||||||
|
}
|
||||||
|
|
||||||
|
check_latest() {
|
||||||
|
git fetch --tags origin
|
||||||
|
|
||||||
|
local_head_commit=$(git rev-parse HEAD 2>/dev/null)
|
||||||
|
remote_head_commit=$(git rev-parse FETCH_HEAD 2>/dev/null)
|
||||||
|
if [ "${local_head_commit}" != "${remote_head_commit}" ]; then
|
||||||
|
echo_nok "HEAD is at '${local_head_commit}', but FETCH_HEAD is at '${remote_head_commit}'."
|
||||||
|
echo_hint "Please ensure that you have pushed and pulled all the latest chanegs: git pull --prune --rebase origin; git push origin"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo_ok "HEAD and FETCH_HEAD both point to '${local_head_commit}'."
|
||||||
|
}
|
||||||
|
|
||||||
|
check_tag() {
|
||||||
|
local tag
|
||||||
|
|
||||||
|
tag=$(<VERSION)
|
||||||
|
if git rev-parse "${tag}" 2>/dev/null >/dev/null; then
|
||||||
|
echo_nok "The tag '${tag}' already points to '$(git rev-parse "${tag}" 2>/dev/null)'."
|
||||||
|
echo_hint "Please ensure that the 'VERSION' file has been updated before trying to release: echo X.Y.Z > VERSION"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo_ok "The tag '${tag}' does not exist yet."
|
||||||
|
}
|
||||||
|
|
||||||
|
check_develop() {
|
||||||
|
echomoji 📋 "?" "Checking 'develop' branch"
|
||||||
|
|
||||||
|
check_branch develop
|
||||||
|
check_upstream develop
|
||||||
|
check_clean_repo
|
||||||
|
check_latest
|
||||||
|
}
|
||||||
|
|
||||||
|
check_release() {
|
||||||
|
echomoji 📋 "?" "Checking 'release' branch"
|
||||||
|
|
||||||
|
check_upstream release
|
||||||
|
check_clean_repo
|
||||||
|
check_latest
|
||||||
|
}
|
||||||
|
|
||||||
|
# git errors shall exit with code 2
|
||||||
|
|
||||||
|
git_switch() {
|
||||||
|
echomoji 🔀 "≈" "Switching to '${1}' branch…"
|
||||||
|
if ! git checkout "${1}" >/dev/null; then
|
||||||
|
echo_nok "It was not possible to switch to the branch '${1}'."
|
||||||
|
exit 2
|
||||||
|
fi
|
||||||
|
echo_ok "The branch is now '${1}'."
|
||||||
|
}
|
||||||
|
|
||||||
|
git_tag() {
|
||||||
|
echomoji 🏷 "X" "Tagging version '${1}'…"
|
||||||
|
if ! git tag "${1}"; then
|
||||||
|
echo_nok "The tag '${1}' was not created because of an error."
|
||||||
|
exit 2
|
||||||
|
fi
|
||||||
|
echo_ok "The tag '$(<VERSION)' was created."
|
||||||
|
}
|
||||||
|
|
||||||
|
git_push() {
|
||||||
|
echomoji ⏩ "»" "Pushing the tag '${2}' to '${1}'…"
|
||||||
|
if ! git push "${1}" "${2}"; then
|
||||||
|
echo_nok "The tag '${2}' could not be pushed to '${1}'."
|
||||||
|
exit 2
|
||||||
|
fi
|
||||||
|
echo_ok "The tag '${2}' was pushed."
|
||||||
|
}
|
||||||
|
|
||||||
|
git_merge() {
|
||||||
|
echomoji ⏩ "»" "Merging '${1}'…"
|
||||||
|
if ! git merge --no-ff "${1}"; then
|
||||||
|
echo_nok "The branch '${1}' could not be merged."
|
||||||
|
exit 2
|
||||||
|
fi
|
||||||
|
echo_ok "The branch '${2}' was merged."
|
||||||
|
}
|
||||||
|
|
||||||
|
git_merge() {
|
||||||
|
echomoji ⏩ "»" "Rebasing onto '${1}'…"
|
||||||
|
if ! git rebase "${1}"; then
|
||||||
|
echo_nok "Could not rebase onto '${1}'."
|
||||||
|
exit 2
|
||||||
|
fi
|
||||||
|
echo_ok "Rebased onto '${2}'."
|
||||||
|
}
|
||||||
|
|
||||||
|
###
|
||||||
|
# MAIN
|
||||||
|
###
|
||||||
|
|
||||||
|
echomoji 📋 "▶︎" "Checking pre-requisites for releasing '$(<VERSION)'"
|
||||||
|
|
||||||
|
check_origin
|
||||||
|
|
||||||
|
check_develop
|
||||||
|
check_tag
|
||||||
|
|
||||||
|
git_switch release
|
||||||
|
check_release
|
||||||
|
|
||||||
|
echomoji 📋 "▶︎" "Releasing '$(<VERSION)'"
|
||||||
|
|
||||||
|
git_merge develop
|
||||||
|
check_tag
|
||||||
|
git_tag "$(<VERSION)"
|
||||||
|
|
||||||
|
git_push "origin" release
|
||||||
|
git_push "origin" "$(<VERSION)"
|
||||||
|
|
||||||
|
git_switch develop
|
||||||
|
git_rebase release
|
||||||
|
|
||||||
|
echomoji ✅ "◼︎" "The release of '$(<VERSION)' is complete."
|
|
@ -0,0 +1,14 @@
|
||||||
|
{
|
||||||
|
"extends": [
|
||||||
|
"config:base",
|
||||||
|
":disableDependencyDashboard"
|
||||||
|
],
|
||||||
|
"enabled": true,
|
||||||
|
"labels": ["maintenance"],
|
||||||
|
"baseBranches": ["develop"],
|
||||||
|
"pip_requirements": {
|
||||||
|
"fileMatch": [
|
||||||
|
"requirements-container.txt"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
|
@ -1,4 +1,4 @@
|
||||||
from dcim.constants import CONNECTION_STATUS_PLANNED, DEVICE_STATUS_ACTIVE
|
from dcim.choices import DeviceStatusChoices
|
||||||
from dcim.models import ConsolePort, Device, PowerPort
|
from dcim.models import ConsolePort, Device, PowerPort
|
||||||
from extras.reports import Report
|
from extras.reports import Report
|
||||||
|
|
||||||
|
@ -9,13 +9,14 @@ class DeviceConnectionsReport(Report):
|
||||||
def test_console_connection(self):
|
def test_console_connection(self):
|
||||||
|
|
||||||
# Check that every console port for every active device has a connection defined.
|
# Check that every console port for every active device has a connection defined.
|
||||||
for console_port in ConsolePort.objects.select_related('device').filter(device__status=DEVICE_STATUS_ACTIVE):
|
active = DeviceStatusChoices.STATUS_ACTIVE
|
||||||
|
for console_port in ConsolePort.objects.prefetch_related('device').filter(device__status=active):
|
||||||
if console_port.connected_endpoint is None:
|
if console_port.connected_endpoint is None:
|
||||||
self.log_failure(
|
self.log_failure(
|
||||||
console_port.device,
|
console_port.device,
|
||||||
"No console connection defined for {}".format(console_port.name)
|
"No console connection defined for {}".format(console_port.name)
|
||||||
)
|
)
|
||||||
elif console_port.connection_status == CONNECTION_STATUS_PLANNED:
|
elif not console_port.connection_status:
|
||||||
self.log_warning(
|
self.log_warning(
|
||||||
console_port.device,
|
console_port.device,
|
||||||
"Console connection for {} marked as planned".format(console_port.name)
|
"Console connection for {} marked as planned".format(console_port.name)
|
||||||
|
@ -26,12 +27,12 @@ class DeviceConnectionsReport(Report):
|
||||||
def test_power_connections(self):
|
def test_power_connections(self):
|
||||||
|
|
||||||
# Check that every active device has at least two connected power supplies.
|
# Check that every active device has at least two connected power supplies.
|
||||||
for device in Device.objects.filter(status=DEVICE_STATUS_ACTIVE):
|
for device in Device.objects.filter(status=DeviceStatusChoices.STATUS_ACTIVE):
|
||||||
connected_ports = 0
|
connected_ports = 0
|
||||||
for power_port in PowerPort.objects.filter(device=device):
|
for power_port in PowerPort.objects.filter(device=device):
|
||||||
if power_port.connected_endpoint is not None:
|
if power_port.connected_endpoint is not None:
|
||||||
connected_ports += 1
|
connected_ports += 1
|
||||||
if power_port.connection_status == CONNECTION_STATUS_PLANNED:
|
if not power_port.connection_status:
|
||||||
self.log_warning(
|
self.log_warning(
|
||||||
device,
|
device,
|
||||||
"Power connection for {} marked as planned".format(power_port.name)
|
"Power connection for {} marked as planned".format(power_port.name)
|
||||||
|
@ -43,4 +44,3 @@ class DeviceConnectionsReport(Report):
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
self.log_success(device)
|
self.log_success(device)
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,6 @@
|
||||||
|
django-auth-ldap==4.1.0
|
||||||
|
django-storages[azure,boto3,dropbox,google,libcloud,sftp]==1.13.1
|
||||||
|
napalm==4.0.0
|
||||||
|
psycopg2==2.9.5
|
||||||
|
python3-saml==1.14.0
|
||||||
|
social-auth-core[all]==4.3.0
|
|
@ -1,34 +0,0 @@
|
||||||
from django.contrib.auth.models import Permission, Group, User
|
|
||||||
from users.models import Token
|
|
||||||
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/users.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml=YAML(typ='safe')
|
|
||||||
users = yaml.load(stream)
|
|
||||||
|
|
||||||
if users is not None:
|
|
||||||
for username, user_details in users.items():
|
|
||||||
if not User.objects.filter(username=username):
|
|
||||||
user = User.objects.create_user(
|
|
||||||
username = username,
|
|
||||||
password = user_details.get('password', 0) or User.objects.make_random_password)
|
|
||||||
|
|
||||||
print("👤 Created user ",username)
|
|
||||||
|
|
||||||
if user_details.get('api_token', 0):
|
|
||||||
Token.objects.create(user=user, key=user_details['api_token'])
|
|
||||||
|
|
||||||
user_permissions = user_details.get('permissions', [])
|
|
||||||
if user_permissions:
|
|
||||||
user.user_permissions.clear()
|
|
||||||
for permission_codename in user_details.get('permissions', []):
|
|
||||||
for permission in Permission.objects.filter(codename=permission_codename):
|
|
||||||
user.user_permissions.add(permission)
|
|
||||||
user.save()
|
|
|
@ -1,32 +0,0 @@
|
||||||
from django.contrib.auth.models import Permission, Group, User
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/groups.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml=YAML(typ='safe')
|
|
||||||
groups = yaml.load(stream)
|
|
||||||
|
|
||||||
if groups is not None:
|
|
||||||
for groupname, group_details in groups.items():
|
|
||||||
group, created = Group.objects.get_or_create(name=groupname)
|
|
||||||
|
|
||||||
if created:
|
|
||||||
print("👥 Created group", groupname)
|
|
||||||
|
|
||||||
for username in group_details.get('users', []):
|
|
||||||
user = User.objects.get(username=username)
|
|
||||||
|
|
||||||
if user:
|
|
||||||
user.groups.add(group)
|
|
||||||
|
|
||||||
group_permissions = group_details.get('permissions', [])
|
|
||||||
if group_permissions:
|
|
||||||
group.permissions.clear()
|
|
||||||
for permission_codename in group_details.get('permissions', []):
|
|
||||||
for permission in Permission.objects.filter(codename=permission_codename):
|
|
||||||
group.permissions.add(permission)
|
|
|
@ -1,59 +0,0 @@
|
||||||
from extras.models import CustomField, CustomFieldChoice
|
|
||||||
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
def get_class_for_class_path(class_path):
|
|
||||||
import importlib
|
|
||||||
from django.contrib.contenttypes.models import ContentType
|
|
||||||
|
|
||||||
module_name, class_name = class_path.rsplit(".", 1)
|
|
||||||
module = importlib.import_module(module_name)
|
|
||||||
clazz = getattr(module, class_name)
|
|
||||||
return ContentType.objects.get_for_model(clazz)
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/custom_fields.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml = YAML(typ='safe')
|
|
||||||
customfields = yaml.load(stream)
|
|
||||||
|
|
||||||
if customfields is not None:
|
|
||||||
for cf_name, cf_details in customfields.items():
|
|
||||||
custom_field, created = CustomField.objects.get_or_create(name = cf_name)
|
|
||||||
|
|
||||||
if created:
|
|
||||||
if cf_details.get('default', 0):
|
|
||||||
custom_field.default = cf_details['default']
|
|
||||||
|
|
||||||
if cf_details.get('description', 0):
|
|
||||||
custom_field.description = cf_details['description']
|
|
||||||
|
|
||||||
if cf_details.get('label', 0):
|
|
||||||
custom_field.label = cf_details['label']
|
|
||||||
|
|
||||||
for object_type in cf_details.get('on_objects', []):
|
|
||||||
custom_field.obj_type.add(get_class_for_class_path(object_type))
|
|
||||||
|
|
||||||
if cf_details.get('required', 0):
|
|
||||||
custom_field.required = cf_details['required']
|
|
||||||
|
|
||||||
if cf_details.get('type', 0):
|
|
||||||
custom_field.type = cf_details['type']
|
|
||||||
|
|
||||||
if cf_details.get('weight', 0):
|
|
||||||
custom_field.weight = cf_details['weight']
|
|
||||||
|
|
||||||
custom_field.save()
|
|
||||||
|
|
||||||
for idx, choice_details in enumerate(cf_details.get('choices', [])):
|
|
||||||
choice, _ = CustomFieldChoice.objects.get_or_create(
|
|
||||||
field=custom_field,
|
|
||||||
value=choice_details['value'],
|
|
||||||
defaults={'weight': idx * 10}
|
|
||||||
)
|
|
||||||
|
|
||||||
print("🔧 Created custom field", cf_name)
|
|
|
@ -1,31 +0,0 @@
|
||||||
from dcim.models import Region
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/regions.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml=YAML(typ='safe')
|
|
||||||
regions = yaml.load(stream)
|
|
||||||
|
|
||||||
optional_assocs = {
|
|
||||||
'parent': (Region, 'name')
|
|
||||||
}
|
|
||||||
|
|
||||||
if regions is not None:
|
|
||||||
for params in regions:
|
|
||||||
|
|
||||||
for assoc, details in optional_assocs.items():
|
|
||||||
if assoc in params:
|
|
||||||
model, field = details
|
|
||||||
query = { field: params.pop(assoc) }
|
|
||||||
|
|
||||||
params[assoc] = model.objects.get(**query)
|
|
||||||
|
|
||||||
region, created = Region.objects.get_or_create(**params)
|
|
||||||
|
|
||||||
if created:
|
|
||||||
print("🌐 Created region", region.name)
|
|
|
@ -1,46 +0,0 @@
|
||||||
from dcim.models import Region, Site
|
|
||||||
from extras.models import CustomField, CustomFieldValue
|
|
||||||
from tenancy.models import Tenant
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/sites.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml = YAML(typ='safe')
|
|
||||||
sites = yaml.load(stream)
|
|
||||||
|
|
||||||
optional_assocs = {
|
|
||||||
'region': (Region, 'name'),
|
|
||||||
'tenant': (Tenant, 'name')
|
|
||||||
}
|
|
||||||
|
|
||||||
if sites is not None:
|
|
||||||
for params in sites:
|
|
||||||
custom_fields = params.pop('custom_fields', None)
|
|
||||||
|
|
||||||
for assoc, details in optional_assocs.items():
|
|
||||||
if assoc in params:
|
|
||||||
model, field = details
|
|
||||||
query = { field: params.pop(assoc) }
|
|
||||||
|
|
||||||
params[assoc] = model.objects.get(**query)
|
|
||||||
|
|
||||||
site, created = Site.objects.get_or_create(**params)
|
|
||||||
|
|
||||||
if created:
|
|
||||||
if custom_fields is not None:
|
|
||||||
for cf_name, cf_value in custom_fields.items():
|
|
||||||
custom_field = CustomField.objects.get(name=cf_name)
|
|
||||||
custom_field_value = CustomFieldValue.objects.create(
|
|
||||||
field=custom_field,
|
|
||||||
obj=site,
|
|
||||||
value=cf_value
|
|
||||||
)
|
|
||||||
|
|
||||||
site.custom_field_values.add(custom_field_value)
|
|
||||||
|
|
||||||
print("📍 Created site", site.name)
|
|
|
@ -1,19 +0,0 @@
|
||||||
from dcim.models import Manufacturer
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/manufacturers.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml = YAML(typ='safe')
|
|
||||||
manufacturers = yaml.load(stream)
|
|
||||||
|
|
||||||
if manufacturers is not None:
|
|
||||||
for params in manufacturers:
|
|
||||||
manufacturer, created = Manufacturer.objects.get_or_create(**params)
|
|
||||||
|
|
||||||
if created:
|
|
||||||
print("🏭 Created Manufacturer", manufacturer.name)
|
|
|
@ -1,56 +0,0 @@
|
||||||
from dcim.models import DeviceType, Manufacturer, Region
|
|
||||||
from tenancy.models import Tenant
|
|
||||||
from extras.models import CustomField, CustomFieldValue
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/device_types.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml = YAML(typ='safe')
|
|
||||||
device_types = yaml.load(stream)
|
|
||||||
|
|
||||||
required_assocs = {
|
|
||||||
'manufacturer': (Manufacturer, 'name')
|
|
||||||
}
|
|
||||||
|
|
||||||
optional_assocs = {
|
|
||||||
'region': (Region, 'name'),
|
|
||||||
'tenant': (Tenant, 'name')
|
|
||||||
}
|
|
||||||
|
|
||||||
if device_types is not None:
|
|
||||||
for params in device_types:
|
|
||||||
custom_fields = params.pop('custom_fields', None)
|
|
||||||
|
|
||||||
for assoc, details in required_assocs.items():
|
|
||||||
model, field = details
|
|
||||||
query = { field: params.pop(assoc) }
|
|
||||||
|
|
||||||
params[assoc] = model.objects.get(**query)
|
|
||||||
|
|
||||||
for assoc, details in optional_assocs.items():
|
|
||||||
if assoc in params:
|
|
||||||
model, field = details
|
|
||||||
query = { field: params.pop(assoc) }
|
|
||||||
|
|
||||||
params[assoc] = model.objects.get(**query)
|
|
||||||
|
|
||||||
device_type, created = DeviceType.objects.get_or_create(**params)
|
|
||||||
|
|
||||||
if created:
|
|
||||||
if custom_fields is not None:
|
|
||||||
for cf_name, cf_value in custom_fields.items():
|
|
||||||
custom_field = CustomField.objects.get(name=cf_name)
|
|
||||||
custom_field_value = CustomFieldValue.objects.create(
|
|
||||||
field=custom_field,
|
|
||||||
obj=device_type,
|
|
||||||
value=cf_value
|
|
||||||
)
|
|
||||||
|
|
||||||
device_type.custom_field_values.add(custom_field_value)
|
|
||||||
|
|
||||||
print("🔡 Created device type", device_type.manufacturer, device_type.model)
|
|
|
@ -1,28 +0,0 @@
|
||||||
from dcim.models import RackRole
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
from utilities.forms import COLOR_CHOICES
|
|
||||||
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/rack_roles.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml=YAML(typ='safe')
|
|
||||||
rack_roles = yaml.load(stream)
|
|
||||||
|
|
||||||
if rack_roles is not None:
|
|
||||||
for params in rack_roles:
|
|
||||||
if 'color' in params:
|
|
||||||
color = params.pop('color')
|
|
||||||
|
|
||||||
for color_tpl in COLOR_CHOICES:
|
|
||||||
if color in color_tpl:
|
|
||||||
params['color'] = color_tpl[0]
|
|
||||||
|
|
||||||
rack_role, created = RackRole.objects.get_or_create(**params)
|
|
||||||
|
|
||||||
if created:
|
|
||||||
print("🎨 Created rack role", rack_role.name)
|
|
|
@ -1,31 +0,0 @@
|
||||||
from dcim.models import Site,RackGroup
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/rack_groups.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml=YAML(typ='safe')
|
|
||||||
rack_groups= yaml.load(stream)
|
|
||||||
|
|
||||||
required_assocs = {
|
|
||||||
'site': (Site, 'name')
|
|
||||||
}
|
|
||||||
|
|
||||||
if rack_groups is not None:
|
|
||||||
for params in rack_groups:
|
|
||||||
|
|
||||||
for assoc, details in required_assocs.items():
|
|
||||||
model, field = details
|
|
||||||
query = { field: params.pop(assoc) }
|
|
||||||
params[assoc] = model.objects.get(**query)
|
|
||||||
|
|
||||||
rack_group, created = RackGroup.objects.get_or_create(**params)
|
|
||||||
|
|
||||||
if created:
|
|
||||||
print("🎨 Created rack group", rack_group.name)
|
|
||||||
|
|
|
@ -1,57 +0,0 @@
|
||||||
from dcim.models import Site, RackRole, Rack, RackGroup
|
|
||||||
from tenancy.models import Tenant
|
|
||||||
from extras.models import CustomField, CustomFieldValue
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/racks.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml = YAML(typ='safe')
|
|
||||||
racks = yaml.load(stream)
|
|
||||||
|
|
||||||
required_assocs = {
|
|
||||||
'site': (Site, 'name')
|
|
||||||
}
|
|
||||||
|
|
||||||
optional_assocs = {
|
|
||||||
'role': (RackRole, 'name'),
|
|
||||||
'tenant': (Tenant, 'name'),
|
|
||||||
'group': (RackGroup, 'name')
|
|
||||||
}
|
|
||||||
|
|
||||||
if racks is not None:
|
|
||||||
for params in racks:
|
|
||||||
custom_fields = params.pop('custom_fields', None)
|
|
||||||
|
|
||||||
for assoc, details in required_assocs.items():
|
|
||||||
model, field = details
|
|
||||||
query = { field: params.pop(assoc) }
|
|
||||||
|
|
||||||
params[assoc] = model.objects.get(**query)
|
|
||||||
|
|
||||||
for assoc, details in optional_assocs.items():
|
|
||||||
if assoc in params:
|
|
||||||
model, field = details
|
|
||||||
query = { field: params.pop(assoc) }
|
|
||||||
|
|
||||||
params[assoc] = model.objects.get(**query)
|
|
||||||
|
|
||||||
rack, created = Rack.objects.get_or_create(**params)
|
|
||||||
|
|
||||||
if created:
|
|
||||||
if custom_fields is not None:
|
|
||||||
for cf_name, cf_value in custom_fields.items():
|
|
||||||
custom_field = CustomField.objects.get(name=cf_name)
|
|
||||||
custom_field_value = CustomFieldValue.objects.create(
|
|
||||||
field=custom_field,
|
|
||||||
obj=rack,
|
|
||||||
value=cf_value
|
|
||||||
)
|
|
||||||
|
|
||||||
rack.custom_field_values.add(custom_field_value)
|
|
||||||
|
|
||||||
print("🔳 Created rack", rack.site, rack.name)
|
|
|
@ -1,29 +0,0 @@
|
||||||
from dcim.models import DeviceRole
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
from utilities.forms import COLOR_CHOICES
|
|
||||||
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/device_roles.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml=YAML(typ='safe')
|
|
||||||
device_roles = yaml.load(stream)
|
|
||||||
|
|
||||||
if device_roles is not None:
|
|
||||||
for params in device_roles:
|
|
||||||
|
|
||||||
if 'color' in params:
|
|
||||||
color = params.pop('color')
|
|
||||||
|
|
||||||
for color_tpl in COLOR_CHOICES:
|
|
||||||
if color in color_tpl:
|
|
||||||
params['color'] = color_tpl[0]
|
|
||||||
|
|
||||||
device_role, created = DeviceRole.objects.get_or_create(**params)
|
|
||||||
|
|
||||||
if created:
|
|
||||||
print("🎨 Created device role", device_role.name)
|
|
|
@ -1,32 +0,0 @@
|
||||||
from dcim.models import Manufacturer, Platform
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/platforms.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml = YAML(typ='safe')
|
|
||||||
platforms = yaml.load(stream)
|
|
||||||
|
|
||||||
optional_assocs = {
|
|
||||||
'manufacturer': (Manufacturer, 'name'),
|
|
||||||
}
|
|
||||||
|
|
||||||
if platforms is not None:
|
|
||||||
for params in platforms:
|
|
||||||
|
|
||||||
for assoc, details in optional_assocs.items():
|
|
||||||
if assoc in params:
|
|
||||||
model, field = details
|
|
||||||
query = { field: params.pop(assoc) }
|
|
||||||
|
|
||||||
params[assoc] = model.objects.get(**query)
|
|
||||||
|
|
||||||
platform, created = Platform.objects.get_or_create(**params)
|
|
||||||
|
|
||||||
if created:
|
|
||||||
print("💾 Created platform", platform.name)
|
|
|
@ -1,19 +0,0 @@
|
||||||
from tenancy.models import TenantGroup
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/tenant_groups.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml = YAML(typ='safe')
|
|
||||||
tenant_groups = yaml.load(stream)
|
|
||||||
|
|
||||||
if tenant_groups is not None:
|
|
||||||
for params in tenant_groups:
|
|
||||||
tenant_group, created = TenantGroup.objects.get_or_create(**params)
|
|
||||||
|
|
||||||
if created:
|
|
||||||
print("🔳 Created Tenant Group", tenant_group.name)
|
|
|
@ -1,45 +0,0 @@
|
||||||
from tenancy.models import Tenant, TenantGroup
|
|
||||||
from extras.models import CustomField, CustomFieldValue
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/tenants.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml = YAML(typ='safe')
|
|
||||||
tenants = yaml.load(stream)
|
|
||||||
|
|
||||||
optional_assocs = {
|
|
||||||
'group': (TenantGroup, 'name')
|
|
||||||
}
|
|
||||||
|
|
||||||
if tenants is not None:
|
|
||||||
for params in tenants:
|
|
||||||
custom_fields = params.pop('custom_fields', None)
|
|
||||||
|
|
||||||
for assoc, details in optional_assocs.items():
|
|
||||||
if assoc in params:
|
|
||||||
model, field = details
|
|
||||||
query = { field: params.pop(assoc) }
|
|
||||||
|
|
||||||
params[assoc] = model.objects.get(**query)
|
|
||||||
|
|
||||||
tenant, created = Tenant.objects.get_or_create(**params)
|
|
||||||
|
|
||||||
if created:
|
|
||||||
if custom_fields is not None:
|
|
||||||
for cf_name, cf_value in custom_fields.items():
|
|
||||||
custom_field = CustomField.objects.get(name=cf_name)
|
|
||||||
custom_field_value = CustomFieldValue.objects.create(
|
|
||||||
field=custom_field,
|
|
||||||
obj=tenant,
|
|
||||||
value=cf_value
|
|
||||||
)
|
|
||||||
|
|
||||||
tenant.custom_field_values.add(custom_field_value)
|
|
||||||
|
|
||||||
print("👩💻 Created Tenant", tenant.name)
|
|
|
@ -1,65 +0,0 @@
|
||||||
from dcim.models import Site, Rack, DeviceRole, DeviceType, Device, Platform
|
|
||||||
from ipam.models import IPAddress
|
|
||||||
from virtualization.models import Cluster
|
|
||||||
from tenancy.models import Tenant
|
|
||||||
from extras.models import CustomField, CustomFieldValue
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/devices.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml = YAML(typ='safe')
|
|
||||||
devices = yaml.load(stream)
|
|
||||||
|
|
||||||
required_assocs = {
|
|
||||||
'device_role': (DeviceRole, 'name'),
|
|
||||||
'device_type': (DeviceType, 'model'),
|
|
||||||
'site': (Site, 'name')
|
|
||||||
}
|
|
||||||
|
|
||||||
optional_assocs = {
|
|
||||||
'tenant': (Tenant, 'name'),
|
|
||||||
'platform': (Platform, 'name'),
|
|
||||||
'rack': (Rack, 'name'),
|
|
||||||
'cluster': (Cluster, 'name'),
|
|
||||||
'primary_ip4': (IPAddress, 'address'),
|
|
||||||
'primary_ip6': (IPAddress, 'address')
|
|
||||||
}
|
|
||||||
|
|
||||||
if devices is not None:
|
|
||||||
for params in devices:
|
|
||||||
custom_fields = params.pop('custom_fields', None)
|
|
||||||
|
|
||||||
for assoc, details in required_assocs.items():
|
|
||||||
model, field = details
|
|
||||||
query = { field: params.pop(assoc) }
|
|
||||||
|
|
||||||
params[assoc] = model.objects.get(**query)
|
|
||||||
|
|
||||||
for assoc, details in optional_assocs.items():
|
|
||||||
if assoc in params:
|
|
||||||
model, field = details
|
|
||||||
query = { field: params.pop(assoc) }
|
|
||||||
|
|
||||||
params[assoc] = model.objects.get(**query)
|
|
||||||
|
|
||||||
device, created = Device.objects.get_or_create(**params)
|
|
||||||
|
|
||||||
if created:
|
|
||||||
if custom_fields is not None:
|
|
||||||
for cf_name, cf_value in custom_fields.items():
|
|
||||||
custom_field = CustomField.objects.get(name=cf_name)
|
|
||||||
custom_field_value = CustomFieldValue.objects.create(
|
|
||||||
field=custom_field,
|
|
||||||
obj=device,
|
|
||||||
value=cf_value
|
|
||||||
)
|
|
||||||
|
|
||||||
device.custom_field_values.add(custom_field_value)
|
|
||||||
|
|
||||||
print("🖥️ Created device", device.name)
|
|
|
@ -1,19 +0,0 @@
|
||||||
from virtualization.models import ClusterType
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/cluster_types.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml = YAML(typ='safe')
|
|
||||||
cluster_types = yaml.load(stream)
|
|
||||||
|
|
||||||
if cluster_types is not None:
|
|
||||||
for params in cluster_types:
|
|
||||||
cluster_type, created = ClusterType.objects.get_or_create(**params)
|
|
||||||
|
|
||||||
if created:
|
|
||||||
print("🧰 Created Cluster Type", cluster_type.name)
|
|
|
@ -1,19 +0,0 @@
|
||||||
from ipam.models import RIR
|
|
||||||
from ruamel.yaml import YAML
|
|
||||||
from pathlib import Path
|
|
||||||
import sys
|
|
||||||
|
|
||||||
file = Path('/opt/netbox/initializers/rirs.yml')
|
|
||||||
if not file.is_file():
|
|
||||||
sys.exit()
|
|
||||||
|
|
||||||
with file.open('r') as stream:
|
|
||||||
yaml = YAML(typ='safe')
|
|
||||||
rirs = yaml.load(stream)
|
|
||||||
|
|
||||||
if rirs is not None:
|
|
||||||
for params in rirs:
|
|
||||||
rir, created = RIR.objects.get_or_create(**params)
|
|
||||||
|
|
||||||
if created:
|
|
||||||
print("🗺️ Created RIR", rir.name)
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue