Skip to content

Latest commit

 

History

History
192 lines (161 loc) · 6.64 KB

index.rst

File metadata and controls

192 lines (161 loc) · 6.64 KB

Welcome to the Kylo Project

kylo logo Kylo website: https://kylo.io

The documentation for the site is organized into a few sections:

.. toctree::
    :maxdepth: 1
    :caption: About

    about/KyloFeatures
    about/KyloFrequentlyAskedQuestions
    about/KyloTerminology
    release-notes/ReleaseNotes
    about/Downloads

.. toctree::
    :maxdepth: 1
    :caption: Installation

    installation/Overview
    installation/Dependencies
    installation/DeploymentChecklist
    installation/CreateServiceAccounts
    installation/PrepareOfflineTar
    installation/InstallKylo
    installation/InstallAdditionalKyloComponents
    installation/EnableKerberos
    installation/AdditionalConfiguration
    installation/KyloApplicationProperties
    installation/GrantHdfsPrivileges
    installation/StartServices
    installation/ImportTemplates
    installation/RunSampleFeed
    installation/ValidateConfiguration


.. toctree::
    :maxdepth: 1
    :caption: Installation Examples

    installation/HDP25ClusterDeploymentGuide
    installation/EMR5.15PersistentClusterWithEdgeNode
    installation/Mapr6.01KyloInstallation

.. toctree::
    :maxdepth: 1
    :caption: Common Configuration

    common-config/Overview
    common-config/AdjustMemory
    common-config/ChangeJavaHome
    Log File Management <common-config/LogFiles>
    common-config/YarnClusterConfiguration
    Configure Spark Shell <common-config/KyloSparkProperties>
    common-config/Postgres_Hive_Metadata_Configuration

.. toctree::
    :maxdepth: 1
    :caption: Security

    Overview <security/Overview>
    Encrypt Passwords <security/EncryptingConfigurationProperties>
    Enable Kerberos for Kylo <security/KerberosKyloConfiguration>
    Enable Kerberos for NiFi <security/KerberosNiFiConfiguration>
    Configure Ranger <security/EnableRangerAuthorizationGuide>
    Configure Sentry <security/EnableSentryAuthorizationGuide>
    Enable SSL for Kylo <security/KyloUIWithSSL>
    Enable SSL for NiFi <security/ConfigureNiFiWithSSL>
    Configure Authentication <security/Authentication>
    Configure Kerberos SPNEGO <security/KyloKerberosSPNEGO>
    Configure Access Control <security/AccessControl>
    Enable Hive User Impersonation <security/KyloUserImpersonation.rst>


.. toctree::
    :maxdepth: 1
    :caption: How to guides

    NiFi Cluster <how-to-guides/SetupaNiFiClusterinaKyloSandbox>
    Kylo Cluster <how-to-guides/KyloClusterConfiguration>
    NiFi & Kylo Provenance <how-to-guides/NiFiKyloProvenance>
    Nifi Processors <how-to-guides/NiFiProcessorsDocs>
    Kylo Templates <how-to-guides/KyloTemplatesDocs>
    Connecting Reusable Templates <how-to-guides/ConnectReusableTemplates>
    Remote Process Groups <how-to-guides/RemoteProcessGroups>
    Kylo Datasources <how-to-guides/KyloDatasources>
    Feed Lineage <how-to-guides/FeedLineage>
    Custom Provenance <how-to-guides/CustomProvenanceEvents>
    S3 & Data Wrangler <how-to-guides/AccessingS3fromtheDataWrangler>
    S3 Data Ingest Template <how-to-guides/S3DataIngestTemplate.rst>
    Azure Data Ingest Template <how-to-guides/AzureBlobDataIngestTemplate.rst>
    SUSE Configuration <how-to-guides/SuseConfigurationChanges>
    Configuration Properties <how-to-guides/ConfigurationProperties>
    Validator Tuning <how-to-guides/ValidatorTuning>
    Kylo & Global Search <how-to-guides/ConfigureKyloForGlobalSearch>
    Service Monitor Plugins <how-to-guides/ServiceMonitorPlugins>
    JMS Providers <how-to-guides/JmsProviders>
    Database Upgrades <how-to-guides/DatabaseUpgrades>
    Icons and Colors <how-to-guides/KyloIconsAndColors>
    Spark Streaming - Twitter Sentiment Analysis <how-to-guides/SparkStreamingTutorial>
    Ambari Service Monitor Plugin <how-to-guides/AmbariServiceMonitor>
    Reindex Historical Feed Data <how-to-guides/ReindexHistoricalFeedData>
    Entity Access Control for Elasticsearch <how-to-guides/EntityAccessControlForElasticsearch>
    Service Level Agreements <how-to-guides/ServiceLevelAgreements>
    Configuration Inspector App <how-to-guides/ConfigurationInspectorApp>
    Teradata Data Ingest Template <how-to-guides/DataIngestTeradataTDCHTemplate>


.. toctree::
    :maxdepth: 1
    :caption: Developer guides

    Contributing <developer-guides/ContributingtoKylo>
    Developer Guide <developer-guides/KyloDeveloperGuide>
    Plugin APIs <developer-guides/PluginApiIndex>
    REST API <developer-guides/KyloRestApi>
    Clean Kylo From Box <developer-guides/CleanKyloFromBox>
    Cloudera Docker Sandbox <developer-guides/ClouderaDockerSandboxDeploymentGuide>
    Hortonworks Sandbox Config <developer-guides/HortonworksSandboxConfiguration>
    Kerberos Install Cloudera <developer-guides/KerberosInstallationExample-Cloudera>
    Kerberos Install HDP <developer-guides/KerberosInstallationExampleHDP2.4>
    Spark Function Definitions <developer-guides/SparkFunctionDefinitions>
    Metadata Events <developer-guides/MetadataEvents>

.. toctree::
    :maxdepth: 1
    :caption: User guides

    user-guides/KyloOperationsGuide

.. toctree::
    :maxdepth: 1
    :caption: Tips and tricks

    tips-tricks/TroubleshootingandTips
    tips-tricks/KyloBestPractices