From 56e636fcf991f243a4bf94ca12b1752854fd8b7a Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Wed, 19 Feb 2025 16:23:39 +0000 Subject: [PATCH] deprecate file types other than yaml and json Signed-off-by: Austin Abro --- examples/config-file/zarf-config.ini | 48 --------------------------- examples/config-file/zarf-config.json | 20 ----------- src/cmd/viper.go | 6 ++++ 3 files changed, 6 insertions(+), 68 deletions(-) delete mode 100644 examples/config-file/zarf-config.ini delete mode 100644 examples/config-file/zarf-config.json diff --git a/examples/config-file/zarf-config.ini b/examples/config-file/zarf-config.ini deleted file mode 100644 index d98a3b1ee6..0000000000 --- a/examples/config-file/zarf-config.ini +++ /dev/null @@ -1,48 +0,0 @@ -# Example config file, use "zarf prepare generate-config zarf-config.ini" to generate a new one -log_level=info - -[package.create] -skip_sbom=false - -# set variables for package create -[package.create.set] -leopard=spots -zebra=stripes - - -[package.deploy] -components=lion - -# set variables for package deploy -[package.deploy.set] -camel_spider=matte -scorpion=iridescent -# dummy tls key showcasing multiline variables and autoindent -tls_key="""-----BEGIN PRIVATE KEY----- -MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDDvKUzWiZucm6/ -8D2Nx4KVe8t6uHtARpw112f4yGv7xKcOJkbxLbVtor8pj/HS5tRSZq2ziIQl9y98 -8TVAOBezgzPPMDxOqDeyHl5gAtqzpK/eSPmueZIhR88BH2+SMYqa5kxmjn752Rf0 -jVeCrVdQ5MD9rqA00oQi/zO+gQQoz6QSuiEQ2pSKYB3gv9oIoJorIU1n4qLYAezn -TvFwjmKWPPhRdyslpcAi1rVO+mVX3Y2DKU/CfpWNFVVT+H788Srn4yP6iWUymfQU -vHOXII1erMnES2H9BDffumrRf3m3IpgueQ3vPhB8ftjFZozURj2t/WSeaKsyQSoZ -Wr99DWxpAgMBAAECggEAAW8ARsACSAzOgtlfmgo8Cpw9gUiYnn/l5P8O4+OT5uQp -1RCytFGBYqwuej9zpffK1k+qNgZp8V0+G8wod6/xfH8Zggr4ZhsVTVirmEhtEaPD -Jf2i1oRNbbD48yknyApU2Y2WQaoJhArzAfeHDI34db83KqR8x+ZC0X7NAjgvr5zS -b0OfY2tht4oxEWh2m67FzlFgF+cWyszRYyfvHfOFBqLesuCnSfMoOzmbT3SlnxHo -6GSa1e/kCJVzFJNb74BZTIH0w6Ar/a0QG829VXivqj8lRENU/1xUI2JhNz4RdH7F -6MeiwQbq4pWjHfh4djuzQFIwOgCnSNRnNuNywOVuAQKBgQDjleEI1XFQawXmHtHu -6GMhbgptRoSUyutDDdo2MHGvDbxDOIsczIBjxCuYAM47nmGMuWbDJUN+2VQAX32J -WZagRxWikxnEqv3B7No7tLSQ42rRo/tDBrZPCCuS9u/ZJM4o7MCa/VzTtbicGOCh -bTIoTeEtT2piIdkrjHFGGlYOLQKBgQDcLNFHrSJCkHfCoz75+zytfYan+2dIxuV/ -MlnrT8XHt33cst4ZwoIQbsE6mv7J4CJqOgUYDvoJpioLV3InUACDxXd+bVY7RwxP -j25pXzYL++RctVO3IEOCmFkwlq0fNFdrOn8Y/cnRTwd2e60n08rCKgJS8KhEAaO0 -QvVmAHw4rQKBgQDL7hCAnunzuoLFqpZI8tlpKjaTpp3EynO3WSFQb2ZfCvrIbVFS -U/kz7KN3iDlEeO5GcBeiA7EQaGN6FhbiTXHIWwoK7K8paGMMM1V2LL2kGvQruDm8 -3LXd6Z9KCJXxSKanS0ZnW2KjnnE3Bp+6ZqOMNATzWfckydnUyPrza0PzXQKBgEYS -1YCUb8Tzqcn+nrp85XDp9INeFh8pfj0fT1L/DpljouEs5Fcaer60ITd/wPuLJCje -0mQ30AhmJBd7+07bvW4y2LcaIUm4cQiZQ7CxpsfloWaIJ16vHA1iY3B9ZBf8Vp4/ -/dd8XlEJb/ybnB6C35MwP5EaGtOaGfnzHZsbKG35AoGAWm9tpqhuldQ3MCvoAr5Q -b42JLSKqwpvVjQDiFZPI/0wZTo3WkWm9Rd7CAACheb8S70K1r/JIzsmIcnj0v4xs -sfd+R35UE+m8MExbDP4lKFParmvi2/UZfb3VFNMmMPTV6AEIBl6N4PmhHMZOsIRs -H4RxbE+FpmsMAUCpdrzvFkc= ------END PRIVATE KEY-----""" diff --git a/examples/config-file/zarf-config.json b/examples/config-file/zarf-config.json deleted file mode 100644 index 71dc0ae231..0000000000 --- a/examples/config-file/zarf-config.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "log_level": "info", - "package": { - "create": { - "skip_sbom": false, - "set": { - "zebra": "stripes", - "leopard": "spots" - } - }, - "deploy": { - "components": "lion", - "set": { - "scorpion": "iridescent", - "camel_spider": "matte", - "tls_key": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDDvKUzWiZucm6/\n8D2Nx4KVe8t6uHtARpw112f4yGv7xKcOJkbxLbVtor8pj/HS5tRSZq2ziIQl9y98\n8TVAOBezgzPPMDxOqDeyHl5gAtqzpK/eSPmueZIhR88BH2+SMYqa5kxmjn752Rf0\njVeCrVdQ5MD9rqA00oQi/zO+gQQoz6QSuiEQ2pSKYB3gv9oIoJorIU1n4qLYAezn\nTvFwjmKWPPhRdyslpcAi1rVO+mVX3Y2DKU/CfpWNFVVT+H788Srn4yP6iWUymfQU\nvHOXII1erMnES2H9BDffumrRf3m3IpgueQ3vPhB8ftjFZozURj2t/WSeaKsyQSoZ\nWr99DWxpAgMBAAECggEAAW8ARsACSAzOgtlfmgo8Cpw9gUiYnn/l5P8O4+OT5uQp\n1RCytFGBYqwuej9zpffK1k+qNgZp8V0+G8wod6/xfH8Zggr4ZhsVTVirmEhtEaPD\nJf2i1oRNbbD48yknyApU2Y2WQaoJhArzAfeHDI34db83KqR8x+ZC0X7NAjgvr5zS\nb0OfY2tht4oxEWh2m67FzlFgF+cWyszRYyfvHfOFBqLesuCnSfMoOzmbT3SlnxHo\n6GSa1e/kCJVzFJNb74BZTIH0w6Ar/a0QG829VXivqj8lRENU/1xUI2JhNz4RdH7F\n6MeiwQbq4pWjHfh4djuzQFIwOgCnSNRnNuNywOVuAQKBgQDjleEI1XFQawXmHtHu\n6GMhbgptRoSUyutDDdo2MHGvDbxDOIsczIBjxCuYAM47nmGMuWbDJUN+2VQAX32J\nWZagRxWikxnEqv3B7No7tLSQ42rRo/tDBrZPCCuS9u/ZJM4o7MCa/VzTtbicGOCh\nbTIoTeEtT2piIdkrjHFGGlYOLQKBgQDcLNFHrSJCkHfCoz75+zytfYan+2dIxuV/\nMlnrT8XHt33cst4ZwoIQbsE6mv7J4CJqOgUYDvoJpioLV3InUACDxXd+bVY7RwxP\nj25pXzYL++RctVO3IEOCmFkwlq0fNFdrOn8Y/cnRTwd2e60n08rCKgJS8KhEAaO0\nQvVmAHw4rQKBgQDL7hCAnunzuoLFqpZI8tlpKjaTpp3EynO3WSFQb2ZfCvrIbVFS\nU/kz7KN3iDlEeO5GcBeiA7EQaGN6FhbiTXHIWwoK7K8paGMMM1V2LL2kGvQruDm8\n3LXd6Z9KCJXxSKanS0ZnW2KjnnE3Bp+6ZqOMNATzWfckydnUyPrza0PzXQKBgEYS\n1YCUb8Tzqcn+nrp85XDp9INeFh8pfj0fT1L/DpljouEs5Fcaer60ITd/wPuLJCje\n0mQ30AhmJBd7+07bvW4y2LcaIUm4cQiZQ7CxpsfloWaIJ16vHA1iY3B9ZBf8Vp4/\n/dd8XlEJb/ybnB6C35MwP5EaGtOaGfnzHZsbKG35AoGAWm9tpqhuldQ3MCvoAr5Q\nb42JLSKqwpvVjQDiFZPI/0wZTo3WkWm9Rd7CAACheb8S70K1r/JIzsmIcnj0v4xs\nsfd+R35UE+m8MExbDP4lKFParmvi2/UZfb3VFNMmMPTV6AEIBl6N4PmhHMZOsIRs\nH4RxbE+FpmsMAUCpdrzvFkc=\n-----END PRIVATE KEY-----" - } - } - } -} diff --git a/src/cmd/viper.go b/src/cmd/viper.go index 6a7358d3c2..83b8b6988a 100644 --- a/src/cmd/viper.go +++ b/src/cmd/viper.go @@ -9,6 +9,7 @@ import ( "errors" "fmt" "os" + "path/filepath" "strings" "github.com/zarf-dev/zarf/src/pkg/logger" @@ -190,6 +191,11 @@ func PrintViperConfigUsed(ctx context.Context) error { // Zarf skips loading the config file for version and tool commands, this avoids output in those cases if cfgFile := v.ConfigFileUsed(); cfgFile != "" { l.Info("using config file", "location", cfgFile) + fileType := strings.TrimPrefix(filepath.Ext(cfgFile), ".") + fmt.Println("file type is", fileType) + if !(fileType == "yml" || fileType == "yaml" || fileType == "toml") { + l.Warn("configuration file types other than YAML and TOML are deprecated and will be removed in a future release", "fileType", fileType) + } } return nil }