security-and-authentication.fjson

{"parents": [], "prev": {"link": "../docker-workflows/", "title": "Docker: Dev and Prod Workflows with Runhouse"}, "next": null, "title": "Security and Authentication", "meta": {}, "body": "<section id=\"security-and-authentication\">\n<h1>Security and Authentication<a class=\"headerlink\" href=\"#security-and-authentication\" title=\"Permalink to this heading\">\u00b6</a></h1>\n<p>By default, Runhouse collects metadata from provisioned clusters and data relating to performance and error monitoring.\nThis data will only be used by Runhouse to improve the product.</p>\n<section id=\"cluster-metadata-collection\">\n<h2>Cluster Metadata Collection<a class=\"headerlink\" href=\"#cluster-metadata-collection\" title=\"Permalink to this heading\">\u00b6</a></h2>\n<p>We collect non-sensitive data on the cluster that helps us understand how Runhouse is being used. This data includes:</p>\n<ul class=\"simple\">\n<li><p>Python version</p></li>\n<li><p>Resources (cpus, gpus, memory)</p></li>\n<li><p>Cloud provider</p></li>\n<li><p>Region</p></li>\n<li><p>Instance type</p></li>\n</ul>\n</section>\n<section id=\"cluster-observability\">\n<h2>Cluster Observability<a class=\"headerlink\" href=\"#cluster-observability\" title=\"Permalink to this heading\">\u00b6</a></h2>\n<p>Runhouse collects various telemetry data by default on clusters. This data will be used to provide better observability\ninto logs, traces, and metrics associated with clusters. We will not sell data or buy any observability data collected.</p>\n<p>To disable observability globally for all clusters, set the environment variable <code class=\"code docutils literal notranslate\"><span class=\"pre\">disable_observability</span></code>\nto <code class=\"code docutils literal notranslate\"><span class=\"pre\">True</span></code>. Alternatively, set <code class=\"code docutils literal notranslate\"><span class=\"pre\">disable_observability</span></code> to <code class=\"code docutils literal notranslate\"><span class=\"pre\">true</span></code> in your\nlocal Runhouse config (<code class=\"code docutils literal notranslate\"><span class=\"pre\">~/.rh/config.yaml</span></code>), or in Python:</p>\n<div class=\"highlight-python notranslate\"><div class=\"highlight\"><pre><span></span><span class=\"kn\">import</span> <span class=\"nn\">runhouse</span> <span class=\"k\">as</span> <span class=\"nn\">rh</span>\n<span class=\"n\">rh</span><span class=\"o\">.</span><span class=\"n\">configs</span><span class=\"o\">.</span><span class=\"n\">disable_observability</span><span class=\"p\">()</span>\n</pre></div>\n</div>\n</section>\n</section>\n\n    <script type=\"text/x-thebe-config\">\n    {\n        requestKernel: true,\n        binderOptions: {\n            repo: \"binder-examples/jupyter-stacks-datascience\",\n            ref: \"master\",\n        },\n        codeMirrorConfig: {\n            theme: \"abcdef\",\n            mode: \"python\"\n        },\n        kernelOptions: {\n            name: \"python3\",\n            path: \"./.\"\n        },\n        predefinedOutput: true\n    }\n    </script>\n    <script>kernelName = 'python3'</script>", "metatags": "<meta name=\"generator\" content=\"Docutils 0.19: https://docutils.sourceforge.io/\" />\n", "rellinks": [["genindex", "General Index", "I", "index"], ["py-modindex", "Python Module Index", "", "modules"], ["docker-workflows", "Docker: Dev and Prod Workflows with Runhouse", "P", "previous"]], "sourcename": "security-and-authentication.rst.txt", "toc": "<ul>\n<li><a class=\"reference internal\" href=\"#\">Security and Authentication</a><ul>\n<li><a class=\"reference internal\" href=\"#cluster-metadata-collection\">Cluster Metadata Collection</a></li>\n<li><a class=\"reference internal\" href=\"#cluster-observability\">Cluster Observability</a></li>\n</ul>\n</li>\n</ul>\n", "display_toc": true, "page_source_suffix": ".rst", "globaltoc": "<p class=\"caption\" role=\"heading\"><span class=\"caption-text\">Getting Started</span></p>\n<ul>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"installation-setup/\">Installation and Compute Setup</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"tutorials/quick-start-cloud/\">Quick Start</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"development-guide/\">Development Guide</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"runhouse-in-your-stack/\">Working with Common Libraries and Tools</a></li>\n</ul>\n<p class=\"caption\" role=\"heading\"><span class=\"caption-text\">API Basics</span></p>\n<ul>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"tutorials/api-clusters/\">Clusters</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"tutorials/api-modules/\">Functions and Modules</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"tutorials/api-process/\">Processes</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"tutorials/api-images/\">Images</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"tutorials/api-folders/\">Folders</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"tutorials/api-secrets/\">Secrets</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"tutorials/api-resources/\">Resource Management</a></li>\n</ul>\n<p class=\"caption\" role=\"heading\"><span class=\"caption-text\">API Reference</span></p>\n<ul>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"api/python/\">Python API</a><ul>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/python/resource/\">Resource</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/python/function/\">Function</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/python/cluster/\">Cluster</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/python/image/\">Image</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/python/package/\">Package</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/python/module/\">Module</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/python/folder/\">Folder</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/python/secrets/\">Secrets</a></li>\n<li class=\"toctree-l2\"><a class=\"reference internal\" href=\"api/python/login/\">Login/Logout</a></li>\n</ul>\n</li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"api/cli/\">Command Line Interface</a></li>\n</ul>\n<p class=\"caption\" role=\"heading\"><span class=\"caption-text\">Other Topics</span></p>\n<ul>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"tutorials/async/\">Asynchronous Programming</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"installation/\">Installation and Setup</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"debugging-logging/\">Debugging and Logging</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"docker-setup/\">Docker: Cluster Setup</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"docker-workflows/\">Docker: Dev and Prod Workflows with Runhouse</a></li>\n<li class=\"toctree-l1\"><a class=\"reference internal\" href=\"security-and-authentication/\">Security and Authentication</a></li>\n</ul>\n", "current_page_name": "security-and-authentication", "sidebars": ["about.html", "navigation.html", "relations.html", "searchbox.html", "donate.html"], "customsidebar": null, "alabaster_version": "0.7.16", "alabaster_version_info": [0, 7, 16]}