CINXE.COM
Documentation |
<!doctype html> <html lang="en" class="no-js"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="Hugo 0.86.0" /> <META NAME="ROBOTS" CONTENT="INDEX, FOLLOW"> <link rel="alternate" type="text/html" href="https://runterrascan.io/docs/_print/"> <link rel="shortcut icon" href="/favicons/favicon.ico" > <link rel="apple-touch-icon" href="/favicons/apple-touch-icon-180x180.png" sizes="180x180"> <link rel="icon" type="image/png" href="/favicons/favicon-16x16.png" sizes="16x16"> <link rel="icon" type="image/png" href="/favicons/favicon-32x32.png" sizes="32x32"> <link rel="icon" type="image/png" href="/favicons/android-36x36.png" sizes="36x36"> <link rel="icon" type="image/png" href="/favicons/android-48x48.png" sizes="48x48"> <link rel="icon" type="image/png" href="/favicons/android-72x72.png" sizes="72x72"> <link rel="icon" type="image/png" href="/favicons/android-96x96.png" sizes="96x96"> <link rel="icon" type="image/png" href="/favicons/android-144x144.png" sizes="144x144"> <link rel="icon" type="image/png" href="/favicons/android-192x192.png" sizes="192x192"> <title>Documentation | </title><meta property="og:title" content="Documentation" /> <meta property="og:description" content="Terrascan detects security vulnerabilities and compliance violations across your Cloud Native Infrastructure" /> <meta property="og:type" content="website" /> <meta property="og:url" content="https://runterrascan.io/docs/" /> <meta itemprop="name" content="Documentation"> <meta itemprop="description" content="Terrascan detects security vulnerabilities and compliance violations across your Cloud Native Infrastructure"><meta name="twitter:card" content="summary"/> <meta name="twitter:title" content="Documentation"/> <meta name="twitter:description" content="Terrascan detects security vulnerabilities and compliance violations across your Cloud Native Infrastructure"/> <script type="application/javascript"> var doNotTrack = false; if (!doNotTrack) { window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date; ga('create', 'UA-202985922-1', 'auto'); ga('send', 'pageview'); } </script> <script async src='https://www.google-analytics.com/analytics.js'></script> <link rel="preload" href="/scss/main.min.dd17043f80f77ed1f4bbf4c1333420e7569629f81060532d21878ef25be0fc66.css" as="style"> <link href="/scss/main.min.dd17043f80f77ed1f4bbf4c1333420e7569629f81060532d21878ef25be0fc66.css" rel="stylesheet" integrity=""> <link rel="stylesheet" type="text/css" href=https://runterrascan.io/css/asciinema-player.css /> <script src="https://code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script> </head> <body class="td-section"> <header> <nav class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar"> <a class="navbar-brand" href="/"> <span class="navbar-logo"><svg id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 1394.6 479" style="enable-background:new 0 0 1394.6 479"><style>.st0{fill:#fff}.st1{enable-background:new}</style><g id="a"/><g id="b"/><g id="c"/><g id="d"><g><path class="st0" d="M432.3 244.6c-2.9 2.4-6.4 4.1-10.5 5.3-4.1 1.2-8.5 1.8-13.1 1.8-11.6.0-20.5-3-26.8-9.1s-9.5-14.8-9.5-26.4v-94.4H397v24h28.2v19.7H397v50.1c0 5.1 1.3 9 3.8 11.7s6.1 4 10.7 4c5.5.0 10.1-1.4 13.8-4.3l7 17.6z"/><path class="st0" d="M523.7 219.3l13 15.2c-4.6 5.6-10.5 9.9-17.7 12.8-7.2 2.9-15.4 4.3-24.4 4.3-11.6.0-21.7-2.3-30.5-6.9s-15.6-11-20.4-19.2c-4.8-8.2-7.2-17.5-7.2-27.9s2.3-19.5 7-27.7 11.1-14.6 19.3-19.2 17.5-6.9 27.9-6.9 18.8 2.1 26.9 6.4 14.5 10.4 19.2 18.3 7.1 17.2 7.1 27.9l-80.6 15.8c2.5 6 6.5 10.6 12 13.8s12.1 4.7 19.9 4.7C506.6 230.8 516.1 226.9 523.7 219.3zM468.7 172.4c-5.6 5.9-8.4 13.9-8.4 23.8v.2l59.5-11.4c-1.7-6.4-5.2-11.6-10.3-15.6-5.2-3.9-11.5-5.9-18.8-5.9C481.6 163.6 474.3 166.5 468.7 172.4z"/><path class="st0" d="M624.4 143.9v23.4c-2.1-.4-4-.6-5.7-.6-9.6.0-17.1 2.8-22.5 8.4s-8.1 13.6-8.1 24.1v51h-24.6V145H587v15.4C594.1 149.4 606.6 143.9 624.4 143.9z"/><path class="st0" d="M702.3 143.9v23.4c-2.1-.4-4-.6-5.7-.6-9.6.0-17.1 2.8-22.5 8.4s-8.1 13.6-8.1 24.1v51h-24.6V145h23.5v15.4C671.9 149.4 684.4 143.9 702.3 143.9z"/><path class="st0" d="M821.1 145.1v105.2h-23.5v-13.6c-4.1 5-9.1 8.7-15.1 11.2s-12.6 3.7-19.8 3.7c-10.2.0-19.4-2.2-27.5-6.7s-14.4-10.8-18.9-18.9-6.8-17.6-6.8-28.4 2.3-20.2 6.8-28.3c4.5-8.1 10.8-14.4 18.9-18.8 8.1-4.5 17.2-6.7 27.5-6.7 6.8.0 13.1 1.2 18.8 3.6 5.7 2.4 10.7 5.9 14.9 10.4V145L821.1 145.1zM788 221.5c5.9-6 8.9-14 8.9-23.8s-3-17.8-8.9-23.8-13.4-9.1-22.5-9.1-16.5 3-22.4 9.1c-5.8 6-8.8 14-8.8 23.8s2.9 17.8 8.8 23.8c5.8 6 13.3 9.1 22.4 9.1S782.1 227.5 788 221.5z"/><path class="st0" d="M856.9 248.3c-8.2-2.2-14.7-5.1-19.5-8.5l9.5-18.7c4.7 3.1 10.4 5.7 17 7.6s13.2 2.9 19.6 2.9c14.7.0 22.1-3.9 22.1-11.6.0-3.7-1.9-6.2-5.6-7.7-3.7-1.4-9.8-2.8-18-4.1-8.7-1.3-15.7-2.8-21.2-4.5s-10.2-4.7-14.2-9-6-10.2-6-17.8c0-10 4.2-18 12.5-23.9 8.3-6 19.6-9 33.8-9 7.2.0 14.5.8 21.7 2.5s13.1 3.8 17.7 6.6l-9.5 18.7c-8.9-5.2-19-7.9-30.2-7.9-7.2.0-12.7 1.1-16.5 3.2s-5.6 5-5.6 8.6c0 3.9 2 6.7 6 8.4s10.2 3.2 18.6 4.6c8.4 1.3 15.3 2.8 20.7 4.5 5.4 1.7 10 4.6 13.9 8.7s5.8 9.9 5.8 17.3c0 9.9-4.3 17.7-12.8 23.6s-20.2 8.9-34.9 8.9C873.4 251.6 865 250.5 856.9 248.3z"/><path class="st0" d="M965.9 244.8c-8.7-4.6-15.4-11-20.3-19.2s-7.3-17.5-7.3-27.9 2.4-19.6 7.3-27.8 11.6-14.5 20.2-19.1 18.4-6.9 29.5-6.9c10.4.0 19.5 2.1 27.3 6.3 7.8 4.2 13.7 10.2 17.6 18.1l-18.9 11c-3-4.9-6.8-8.5-11.3-10.9s-9.5-3.6-14.9-3.6c-9.2.0-16.8 3-22.9 9s-9.1 14-9.1 23.9 3 18 9 23.9 13.6 9 23 9c5.4.0 10.3-1.2 14.9-3.6 4.5-2.4 8.3-6.1 11.3-10.9l18.9 11c-4.1 7.9-10 14-17.8 18.2-7.8 4.3-16.8 6.4-27.1 6.4C984.4 251.6 974.6 249.3 965.9 244.8z"/><path class="st0" d="M1158.8 145.1v105.2h-23.4v-13.6c-4.1 5-9.1 8.7-15.1 11.2s-12.6 3.7-19.8 3.7c-10.2.0-19.4-2.2-27.5-6.7s-14.4-10.8-18.9-18.9-6.8-17.6-6.8-28.4 2.3-20.2 6.8-28.3 10.8-14.4 18.9-18.8c8.1-4.5 17.2-6.7 27.5-6.7 6.8.0 13.1 1.2 18.8 3.6s10.7 5.9 14.9 10.4V145L1158.8 145.1zM1125.7 221.5c5.9-6 8.9-14 8.9-23.8s-3-17.8-8.9-23.8-13.4-9.1-22.5-9.1-16.5 3-22.4 9.1c-5.8 6-8.8 14-8.8 23.8s2.9 17.8 8.8 23.8c5.8 6 13.3 9.1 22.4 9.1S1119.8 227.5 1125.7 221.5z"/><path class="st0" d="M1278.8 155.5c8 7.8 12 19.2 12 34.5v60.3h-24.6v-57.1c0-9.2-2.2-16.1-6.5-20.8-4.3-4.7-10.5-7-18.5-7-9.1.0-16.2 2.7-21.5 8.2-5.3 5.4-7.9 13.3-7.9 23.6v53.2h-24.6V145.1h23.4v13.6c4.1-4.9 9.2-8.5 15.4-11s13.1-3.7 20.9-3.7C1260.2 143.9 1270.8 147.8 1278.8 155.5z"/></g><g><path class="st0" d="M262.8 276.7c-1.9.0-3.7-.6-5.2-1.9-3.4-2.9-3.9-8-1-11.5 13.8-16.5 21.4-37.4 21.4-58.9.0-50.5-41.1-91.5-91.5-91.5-26.5.0-51.7 11.5-69.1 31.6-2.9 3.4-8.1 3.8-11.5.8-3.4-2.9-3.8-8.1-.8-11.5 20.5-23.6 50.2-37.2 81.4-37.2 59.4.0 107.8 48.4 107.8 107.8.0 25.3-9 49.9-25.2 69.3C267.4 275.7 265.1 276.7 262.8 276.7z"/><path class="st0" d="M164.6 254.5c-1.3.0-2.6-.3-3.8-.9-18.3-9.6-29.7-28.4-29.7-49 0-30.5 24.8-55.3 55.3-55.3 9.3.0 18.6 2.4 26.7 6.9 3.9 2.2 5.4 7.1 3.2 11.1-2.2 3.9-7.1 5.4-11.1 3.2-5.8-3.2-12.3-4.9-18.9-4.9-21.5.0-39.1 17.5-39.1 39.1.0 14.6 8 27.9 21 34.6 4 2.1 5.5 7 3.4 11C170.3 252.9 167.5 254.5 164.6 254.5z"/><path class="st0" d="M113.6 225.9c-3.8.0-7.3-2.8-8-6.7-.9-4.9-1.3-9.8-1.3-14.8.0-45.3 36.9-82.2 82.2-82.2 39.7.0 73.7 28.4 80.9 67.4.8 4.4-2.1 8.6-6.5 9.5-4.4.8-8.6-2.1-9.5-6.5-5.7-31.4-33-54.1-64.9-54.1-36.4.0-65.9 29.6-65.9 65.9.0 4 .4 7.9 1.1 11.9.8 4.4-2.1 8.6-6.5 9.5C114.6 225.9 114.1 225.9 113.6 225.9z"/><circle class="st0" cx="185.9" cy="201.8" r="19.3"/></g><g class="st1"><path class="st0" d="M950.5 326.6c.1 1.7.2 3.9.2 6.5.0 4.9-.3 8.6-1 11.1-1 3.6-2.9 6.4-5.8 8.6-2.8 2.1-6.3 3.2-10.3 3.2-2.6.0-5-.5-7.1-1.6s-3.8-2.6-5-4.5c-.1-.1-.2-.2-.3-.1-.1.0-.1.1-.1.3v4.3c0 .6-.3.9-.9.9h-3c-.6.0-.9-.3-.9-.9v-60c0-.6.3-.9.9-.9h3c.6.0.9.3.9.9v21.7c0 .2.1.3.2.3s.2.0.3-.2c1.3-1.9 2.9-3.4 5-4.5s4.5-1.6 7.1-1.6c4.2.0 7.7 1.1 10.5 3.2 2.8 2.1 4.7 5 5.7 8.7C950.2 323.3 950.4 324.9 950.5 326.6zM945.7 339.7c.2-1.4.3-3.6.3-6.7.0-3.1-.1-5.4-.3-6.8-.2-1.4-.6-2.7-1.1-4-.7-2.4-2.1-4.3-4.1-5.8s-4.5-2.2-7.3-2.2-5.1.8-7 2.2c-1.9 1.5-3.2 3.5-3.8 5.9-.4 1.2-.7 2.5-.9 3.9-.2 1.4-.3 3.7-.3 6.8.0 3 .1 5.2.2 6.6.1 1.4.4 2.7.9 3.8.7 2.5 1.9 4.5 3.8 6s4.3 2.3 7.2 2.3 5.4-.8 7.5-2.3 3.5-3.5 4.1-6C945.2 342.3 945.5 341 945.7 339.7z"/></g><g class="st1"><path class="st0" d="M959 372v-2.3c0-.6.3-.9.9-.9h.4c2.3-.1 4.1-.4 5.4-1.1 1.3-.7 2.4-1.9 3.3-3.7s2-4.6 3.3-8.5c.1-.2.1-.4.0-.5l-15.4-43.2-.1-.4c0-.4.3-.6.8-.6h3.1c.5.0.9.2 1.1.7l12.8 37.4c.1.1.1.2.3.2.1.0.2-.1.3-.2l12.4-37.4c.2-.5.5-.7 1.1-.7h3.1c.7.0.9.3.7 1l-17 48c-1.4 3.8-2.7 6.6-3.9 8.5-1.2 1.8-2.6 3.1-4.3 3.7-1.7.6-3.9 1-6.9 1h-.6C959.2 372.9 959 372.6 959 372z"/></g><g class="st1"><path class="st0" d="M1037.9 318.1c-.2.2-.5.3-.8.3h-9.2c-.3.0-.5.1-.5.4v21.3c0 2.2.5 3.9 1.5 4.9s2.6 1.5 4.7 1.5h2.7c.3.0.6.1.8.3s.3.5.3.8v6.6c0 .6-.4 1-1.1 1.1l-4.7.1c-4.7.0-8.3-.8-10.6-2.4-2.3-1.6-3.5-4.6-3.6-9v-25.1c0-.3-.2-.4-.4-.4h-5.1c-.3.0-.6-.1-.8-.3-.2-.2-.3-.5-.3-.8v-6.2c0-.3.1-.5.3-.8.2-.2.5-.3.8-.3h5.1c.3.0.4-.1.4-.4v-10.3c0-.3.1-.5.3-.7.2-.2.5-.3.8-.3h7.8c.3.0.6.1.8.3s.3.5.3.7v10.3c0 .3.1.4.5.4h9.2c.3.0.6.1.8.3s.3.5.3.8v6.2C1038.2 317.7 1038.1 317.9 1037.9 318.1z"/></g><g class="st1"><path class="st0" d="M1083.5 332.6l-.1 2.7c0 .7-.4 1.1-1.1 1.1h-28.2c-.3.0-.4.1-.4.4.2 1.9.4 3.3.8 4 1.4 4.2 5 6.4 10.5 6.4 4.1.0 7.3-1.6 9.7-4.9.2-.4.5-.5.9-.5.2.0.4.1.6.3l5.6 4.5c.5.4.6.9.3 1.4-1.9 2.6-4.3 4.6-7.4 6-3.1 1.4-6.5 2.1-10.3 2.1-4.7.0-8.7-1-11.9-3.1-3.3-2.1-5.7-4.9-7.2-8.6-1.4-3.2-2.1-7.6-2.1-13.2.0-3.4.4-6.2 1.1-8.3 1.2-4.1 3.5-7.4 6.8-9.7 3.3-2.4 7.3-3.6 12-3.6 11.8.0 18.5 6.1 20 18.2C1083.3 329.1 1083.5 330.7 1083.5 332.6zM1057.6 319.9c-1.5 1.1-2.5 2.6-3.1 4.5-.4 1-.6 2.3-.7 3.9-.1.3.0.4.4.4h18.3c.3.0.5-.1.5-.4-.1-1.5-.3-2.6-.5-3.4-.5-2.1-1.6-3.8-3.2-4.9-1.6-1.2-3.6-1.8-6-1.8C1060.9 318.3 1059 318.8 1057.6 319.9z"/><path class="st0" d="M1124 313.7c2.9 2.8 4.4 6.7 4.4 11.6v28.9c0 .3-.1.5-.3.8-.2.2-.5.3-.8.3h-8.3c-.3.0-.6-.1-.8-.3s-.3-.5-.3-.8v-26.8c0-2.7-.8-4.9-2.3-6.6-1.6-1.7-3.6-2.5-6.2-2.5-2.6.0-4.7.8-6.3 2.5-1.6 1.6-2.4 3.8-2.4 6.5v26.9c0 .3-.1.5-.3.8-.2.2-.5.3-.8.3h-8.3c-.3.0-.6-.1-.8-.3s-.3-.5-.3-.8v-43c0-.3.1-.5.3-.8.2-.2.5-.3.8-.3h8.3c.3.0.6.1.8.3s.3.5.3.8v2.8c0 .2.1.3.2.4.1.1.2.0.3-.2 2.5-3.2 6.2-4.8 11.2-4.8C1117.2 309.5 1121.1 310.9 1124 313.7z"/><path class="st0" d="M1164.1 311.4c2.9 1.3 5.1 3.1 6.7 5.3 1.6 2.3 2.3 4.8 2.3 7.7v29.7c0 .3-.1.5-.3.8-.2.2-.5.3-.8.3h-8.3c-.3.0-.6-.1-.8-.3s-.3-.5-.3-.8v-2.8c0-.2-.1-.3-.2-.3-.1.0-.2.0-.4.1-2.9 3.2-7.2 4.8-12.8 4.8-4.5.0-8.2-1.1-11.1-3.4-2.9-2.2-4.4-5.6-4.4-10 0-4.6 1.6-8.2 4.9-10.7 3.3-2.6 7.9-3.8 13.8-3.8h9.6c.3.0.4-.1.4-.4v-2.1c0-2.3-.7-4.1-2.1-5.3-1.4-1.3-3.5-1.9-6.2-1.9-2.3.0-4.1.4-5.5 1.2s-2.3 1.9-2.7 3.3c-.2.7-.6 1-1.3.9l-8.7-1.1c-.3-.1-.6-.2-.8-.3s-.3-.3-.2-.6c.5-3.6 2.4-6.5 5.9-8.8 3.4-2.3 7.8-3.4 13-3.4C1157.9 309.5 1161.2 310.1 1164.1 311.4zM1159.5 345.5c2.1-1.5 3.1-3.5 3.1-5.8v-4.1c0-.3-.2-.4-.4-.4h-7.6c-3.2.0-5.7.6-7.5 1.8s-2.7 2.9-2.7 5c0 1.9.7 3.3 2.1 4.4 1.4 1 3.2 1.5 5.4 1.5C1154.9 347.8 1157.4 347.1 1159.5 345.5z"/><path class="st0" d="M1221.1 332.6c0 4.2-.6 7.8-1.7 11-1.3 3.9-3.5 6.9-6.4 9.1-2.9 2.2-6.5 3.3-10.8 3.3-4.2.0-7.7-1.6-10.3-4.7-.1-.2-.2-.2-.4-.2-.1.1-.2.2-.2.4v2.7c0 .3-.1.5-.3.8-.2.2-.5.3-.8.3h-8.3c-.3.0-.6-.1-.8-.3s-.3-.5-.3-.8v-59.6c0-.3.1-.5.3-.7s.5-.3.8-.3h8.3c.3.0.6.1.8.3s.3.5.3.7v19.1c0 .2.1.3.2.4.1.1.2.0.4-.1 2.6-3 6-4.5 10.3-4.5 4.4.0 8.1 1.1 11 3.3s5.1 5.2 6.4 9.1C1220.6 325.1 1221.1 328.7 1221.1 332.6zM1210.4 332.7c0-4.6-.9-8.2-2.7-10.8-1.6-2.5-4-3.7-7.2-3.7-2.9.0-5.2 1.3-6.8 3.9-1.5 2.4-2.2 5.9-2.2 10.5.0 4.5.7 7.9 2.1 10.2 1.6 2.8 3.9 4.2 7 4.2 1.7.0 3.2-.4 4.5-1.1 1.3-.7 2.4-1.8 3.2-3.1C1209.7 340.4 1210.4 337 1210.4 332.7z"/><path class="st0" d="M1228.8 354.9c-.2-.2-.3-.5-.3-.8v-59.6c0-.3.1-.5.3-.7s.5-.3.8-.3h8.3c.3.0.6.1.8.3s.3.5.3.7v59.6c0 .3-.1.5-.3.8-.2.2-.5.3-.8.3h-8.3C1229.2 355.2 1229 355.1 1228.8 354.9z"/><path class="st0" d="M1286.4 332.6l-.1 2.7c0 .7-.4 1.1-1.1 1.1H1257c-.3.0-.4.1-.4.4.2 1.9.4 3.3.8 4 1.4 4.2 5 6.4 10.5 6.4 4.1.0 7.3-1.6 9.7-4.9.2-.4.5-.5.9-.5.2.0.4.1.6.3l5.6 4.5c.5.4.6.9.3 1.4-1.9 2.6-4.3 4.6-7.4 6-3.1 1.4-6.5 2.1-10.3 2.1-4.7.0-8.7-1-11.9-3.1-3.3-2.1-5.7-4.9-7.2-8.6-1.4-3.2-2.1-7.6-2.1-13.2.0-3.4.4-6.2 1.1-8.3 1.2-4.1 3.5-7.4 6.8-9.7 3.3-2.4 7.3-3.6 12-3.6 11.8.0 18.5 6.1 20 18.2C1286.3 329.1 1286.4 330.7 1286.4 332.6zM1260.5 319.9c-1.5 1.1-2.5 2.6-3.1 4.5-.4 1-.6 2.3-.7 3.9-.1.3.0.4.4.4h18.3c.3.0.5-.1.5-.4-.1-1.5-.3-2.6-.5-3.4-.5-2.1-1.6-3.8-3.2-4.9-1.6-1.2-3.6-1.8-6-1.8C1263.8 318.3 1262 318.8 1260.5 319.9z"/></g><g><path class="st0" d="M1268.8 114.6h-7v-3.3h17.8v3.3h-7v17.7h-3.9V114.6z"/><path class="st0" d="M1301.9 132.3v-13.9l-6.9 11.5h-1.7l-6.9-11.3v13.7h-3.7v-21h3.2l8.3 13.9 8.2-13.9h3.2v21H1301.9z"/></g></g><g id="e"/></svg></span><span class="text-uppercase font-weight-bold"></span> </a> <div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar"> <ul class="navbar-nav mt-2 mt-lg-0"> <li class="nav-item mr-4 mb-2 mb-lg-0"> <a class="nav-link active" href="/docs/" ><i class='fa fa-book'></i><span class="active">Documentation</span></a> </li> <li class="nav-item mr-4 mb-2 mb-lg-0"> <a class="nav-link" href="/blog/" ><i class='fa fa-blog'></i><span>Blog</span></a> </li> <li class="nav-item mr-4 mb-2 mb-lg-0"> <a class="nav-link" href="/community/" ><i class='fa fa-users'></i><span>Community</span></a> </li> <li class="nav-item mr-4 mb-2 mb-lg-0"> <a class="nav-link" href="https://github.com/tenable/terrascan" target="_blank" ><i class='fab fa-github'></i><span>GitHub</span></a> </li> <li class="nav-item mr-4 mb-2 mb-lg-0"> <a class="nav-link" href="https://discord.gg/59vwVuGyGr" target="_blank" ><i class='fab fa-discord'></i><span>Discord</span></a> </li> </ul> </div> <div class="navbar-nav d-none d-lg-block"> <input type="search" class="form-control td-search-input" placeholder=" Search this site…" aria-label="Search this site…" autocomplete="off"> </div> </nav> </header> <div class="container-fluid td-outer"> <div class="td-main"> <div class="row flex-xl-nowrap"> <aside class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none"> <div id="td-sidebar-menu" class="td-sidebar__inner"> <form class="td-sidebar__search d-flex align-items-center"> <input type="search" class="form-control td-search-input" placeholder=" Search this site…" aria-label="Search this site…" autocomplete="off"> <button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type="button" data-toggle="collapse" data-target="#td-section-nav" aria-controls="td-docs-nav" aria-expanded="false" aria-label="Toggle section navigation"> </button> </form> <nav class="collapse td-sidebar-nav" id="td-section-nav"> <ul class="td-sidebar-nav__section pr-md-3 ul-0"> <li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child active-path" id="m-docs-li"> <a href="/docs/" class="align-left pl-0 active td-sidebar-link td-sidebar-link__section tree-root" id="m-docs"><span class="td-sidebar-nav-active-item">Documentation</span></a> <ul class="ul-1"> <li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-docsgetting-started-li"> <a href="/docs/getting-started/" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id="m-docsgetting-started"><span class="">Getting Started</span></a> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-docsusage-li"> <a href="/docs/usage/" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id="m-docsusage"><span class="">Usage</span></a> <ul class="ul-2 foldable"> <li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id="m-docsusagecommand_line_mode-li"> <a href="/docs/usage/command_line_mode/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-docsusagecommand_line_mode"><span class="">Command Line Options</span></a> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id="m-docsusageserver_mode-li"> <a href="/docs/usage/server_mode/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-docsusageserver_mode"><span class="">Server mode</span></a> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id="m-docsusagein-file_instrumentation-li"> <a href="/docs/usage/in-file_instrumentation/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-docsusagein-file_instrumentation"><span class="">In-file Instrumentation</span></a> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id="m-docsusageconfig_options-li"> <a href="/docs/usage/config_options/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-docsusageconfig_options"><span class="">Configuration File</span></a> </li> </ul> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-docsintegrations-li"> <a href="/docs/integrations/" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id="m-docsintegrations"><span class="">Integrations</span></a> <ul class="ul-2 foldable"> <li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id="m-docsintegrationsk8s-li"> <a href="/docs/integrations/k8s/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-docsintegrationsk8s"><span class="">Kubernetes Admission Controller</span></a> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id="m-docsintegrationsargocd-li"> <a href="/docs/integrations/argocd/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-docsintegrationsargocd"><span class="">Argo CD</span></a> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id="m-docsintegrationsatlantis-li"> <a href="/docs/integrations/atlantis/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-docsintegrationsatlantis"><span class="">Atlantis PR Automation</span></a> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id="m-docsintegrationscicd-li"> <a href="/docs/integrations/cicd/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-docsintegrationscicd"><span class="">GitHub and GitLab</span></a> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id="m-docsintegrationspre-commit-integration-li"> <a href="/docs/integrations/pre-commit-integration/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-docsintegrationspre-commit-integration"><span class="">Pre-commit hook</span></a> </li> </ul> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-docsconcepts-li"> <a href="/docs/concepts/" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id="m-docsconcepts"><span class="">Architecture</span></a> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-docspolicies-li"> <a href="/docs/policies/" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id="m-docspolicies"><span class="">Policies</span></a> <ul class="ul-2 foldable"> <li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id="m-docspoliciespolicies-li"> <a href="/docs/policies/policies/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-docspoliciespolicies"><span class="">Policy Overview</span></a> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id="m-docspoliciesaws-li"> <a href="/docs/policies/aws/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-docspoliciesaws"><span class="">AWS Policies</span></a> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id="m-docspoliciesazure-li"> <a href="/docs/policies/azure/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-docspoliciesazure"><span class="">Azure Policies</span></a> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id="m-docspoliciesgcp-li"> <a href="/docs/policies/gcp/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-docspoliciesgcp"><span class="">GCP Policies</span></a> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id="m-docspoliciesgithub-li"> <a href="/docs/policies/github/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-docspoliciesgithub"><span class="">GitHub Policies</span></a> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id="m-docspoliciesdocker-li"> <a href="/docs/policies/docker/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-docspoliciesdocker"><span class="">Docker Policies</span></a> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id="m-docspoliciesk8s-li"> <a href="/docs/policies/k8s/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-docspoliciesk8s"><span class="">Kubernetes Policies</span></a> </li> </ul> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-docscontribution-guidelines-li"> <a href="/docs/contribution-guidelines/" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id="m-docscontribution-guidelines"><span class="">Contribution Guidelines</span></a> </li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-docsreference-li"> <a href="/docs/reference/" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id="m-docsreference"><span class="">Changelog</span></a> </li> </ul> </li> </ul> </nav> </div> </aside> <aside class="d-none d-xl-block col-xl-2 td-sidebar-toc d-print-none"> <div class="td-page-meta ml-2 pb-1 pt-2 mb-0"> <a href="https://github.com/tenable/runterrascan.io/edit/content/content/en/docs/_index.md" target="_blank"><i class="fa fa-edit fa-fw"></i> Edit this page</a> <a href="https://github.com/tenable/runterrascan.io/new/content/content/en/docs/_index.md?filename=change-me.md&value=---%0Atitle%3A+%22Long+Page+Title%22%0AlinkTitle%3A+%22Short+Nav+Title%22%0Aweight%3A+100%0Adescription%3A+%3E-%0A+++++Page+description+for+heading+and+indexes.%0A---%0A%0A%23%23+Heading%0A%0AEdit+this+template+to+create+your+new+page.%0A%0A%2A+Give+it+a+good+name%2C+ending+in+%60.md%60+-+e.g.+%60getting-started.md%60%0A%2A+Edit+the+%22front+matter%22+section+at+the+top+of+the+page+%28weight+controls+how+its+ordered+amongst+other+pages+in+the+same+directory%3B+lowest+number+first%29.%0A%2A+Add+a+good+commit+message+at+the+bottom+of+the+page+%28%3C80+characters%3B+use+the+extended+description+field+for+more+detail%29.%0A%2A+Create+a+new+branch+so+you+can+preview+your+new+file+and+request+a+review+via+Pull+Request.%0A" target="_blank"><i class="fa fa-edit fa-fw"></i> Create child page</a> <a href="https://github.com/tenable/runterrascan.io/issues/new?title=Documentation" target="_blank"><i class="fab fa-github fa-fw"></i> Create documentation issue</a> <a href="https://github.com/tenable/terrascan/issues/new" target="_blank"><i class="fas fa-tasks fa-fw"></i> Create project issue</a> <a id="print" href="https://runterrascan.io/docs/_print/"><i class="fa fa-print fa-fw"></i> Print entire section</a> </div> </aside> <main class="col-12 col-md-9 col-xl-8 pl-md-5" role="main"> <nav aria-label="breadcrumb" class="d-none d-md-block d-print-none"> <ol class="breadcrumb spb-1"> <li class="breadcrumb-item active" aria-current="page"> <a href="https://runterrascan.io/docs/">Documentation</a> </li> </ol> </nav > <div class="td-content"> <h1>Documentation</h1> <header class="article-meta"> </header> <p><img src="/images/TerrascanTM_BY_Logo.png" alt="Terrascan_Logo"></p> <h1 id="table-of-contents">Table of Contents</h1> <div class="section-index"> <hr class="panel-line"> <div class="entry"> <h5> <a href="/docs/getting-started/">Getting Started</a> </h5> <p>Tutorial on how to install and run Terrascan for the first time.</p> </div> <div class="entry"> <h5> <a href="/docs/usage/">Usage</a> </h5> <p>In depth look into the many options Terrascan supports</p> </div> <div class="entry"> <h5> <a href="/docs/integrations/">Integrations</a> </h5> <p>A growing list of guides on integrating Terrascan with different tools in the software development lifecycle.</p> </div> <div class="entry"> <h5> <a href="/docs/concepts/">Architecture</a> </h5> <p>Understand the pluggable architecture powering Terrascan</p> </div> <div class="entry"> <h5> <a href="/docs/policies/">Policies</a> </h5> <p>Read more about how to write custom policies, and review parts of the policy pack included in Terrascan by default</p> </div> <div class="entry"> <h5> <a href="/docs/contribution-guidelines/">Contribution Guidelines</a> </h5> <p>How to contribute to Terrascan!</p> </div> <div class="entry"> <h5> <a href="/docs/reference/">Changelog</a> </h5> <p>Changelog</p> </div> </div> <style> .feedback--answer { display: inline-block; } .feedback--answer-no { margin-left: 1em; } .feedback--response { display: none; margin-top: 1em; } .feedback--response__visible { display: block; } </style> <div class="d-print-none"> <h2 class="feedback--title">Feedback</h2> <p class="feedback--question">Was this page helpful?</p> <button class="btn btn-primary mb-4 feedback--answer feedback--answer-yes">Yes</button> <button class="btn btn-primary mb-4 feedback--answer feedback--answer-no">No</button> <p class="feedback--response feedback--response-yes"> Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>. </p> <p class="feedback--response feedback--response-no"> Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>. </p> </div> <script> const yesButton = document.querySelector('.feedback--answer-yes'); const noButton = document.querySelector('.feedback--answer-no'); const yesResponse = document.querySelector('.feedback--response-yes'); const noResponse = document.querySelector('.feedback--response-no'); const disableButtons = () => { yesButton.disabled = true; noButton.disabled = true; }; const sendFeedback = (value) => { if (typeof ga !== 'function') return; const args = { command: 'send', hitType: 'event', category: 'Helpful', action: 'click', label: window.location.pathname, value: value }; ga(args.command, args.hitType, args.category, args.action, args.label, args.value); }; yesButton.addEventListener('click', () => { yesResponse.classList.add('feedback--response__visible'); disableButtons(); sendFeedback(1); }); noButton.addEventListener('click', () => { noResponse.classList.add('feedback--response__visible'); disableButtons(); sendFeedback(0); }); </script> <br /> <div class="text-muted mt-5 pt-3 border-top"> Last modified May 12, 2022 : <a href="https://github.com/tenable/runterrascan.io/commit/df0046c0f581f4ed3522b3d4ffa4eb49cca25166">Update _index.md (df0046c)</a> </div> </div> </main> </div> </div> <footer class="bg-dark py-5 row d-print-none" > <div class="container-fluid mx-sm-5"> <div class="row"> <div class="col-6 col-sm-4 text-xs-center order-sm-2"> <ul class="list-inline mb-0"> <li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="Twitter" aria-label="Twitter"> <a class="text-white" target="_blank" rel="noopener noreferrer" href="https://twitter.com/runterrascan"> <i class="fab fa-twitter"></i> </a> </li> <li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="Discord" aria-label="Discord"> <a class="text-white" target="_blank" rel="noopener noreferrer" href="https://discord.com/channels/811956906532929586/833684617482469376"> <i class="fab fa-discord"></i> </a> </li> </ul> </div> <div class="col-6 col-sm-4 text-right text-xs-center order-sm-3"> <p class="text-white">Created by <span> <a href="https://www.tenable.com"> <img src="https://static.tenable.com/press/logos/TenableLogo_White_RGB.png" width="250px"> </a> </span> </p> </div> <div class="col-12 col-sm-4 text-center py-2 order-sm-2"> <small class="text-white">© 2022 Tenable All Rights Reserved</small> </div> </div> </div> </footer> </div> <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.1/dist/umd/popper.min.js" integrity="sha384-9/reFTGAW83EW2RDu2S0VKaIzap3H66lZH81PoYlFhbGU+6BZp6G7niu735Sk7lN" crossorigin="anonymous"></script> <script src="https://cdn.jsdelivr.net/npm/bootstrap@4.6.0/dist/js/bootstrap.min.js" integrity="sha384-+YQ4JLhjyBLPDQt//I+STsc9iw4uQqACwlvpslubQzn4u2UU2UFM80nGisd026JF" crossorigin="anonymous"></script> <script src="/js/main.min.fc6b5e826874e4e45de3ee73e1a5fad30fd045d53193eff0c28332ca0b91b611.js" integrity="sha256-/Gtegmh05ORd4+5z4aX60w/QRdUxk+/wwoMyyguRthE=" crossorigin="anonymous"></script> <script src='/js/prism.js'></script> <script src=https://runterrascan.io/js/asciinema-player.js></script> </body> </html>