Repository: zeppelin Updated Branches: refs/heads/branch-0.8 23d79b733 -> 68cb67619
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/68cb6761/docs/setup/security/shiro_authentication.md ---------------------------------------------------------------------- diff --git a/docs/setup/security/shiro_authentication.md b/docs/setup/security/shiro_authentication.md index a9dd13e..11d5c68 100644 --- a/docs/setup/security/shiro_authentication.md +++ b/docs/setup/security/shiro_authentication.md @@ -46,8 +46,8 @@ Set to property **zeppelin.anonymous.allowed** to **false** in `conf/zeppelin-si ### 3. Start Zeppelin -``` -bin/zeppelin-daemon.sh start (or restart) +```bash +bin/zeppelin-daemon.sh start #(or restart) ``` Then you can browse Zeppelin at [http://localhost:8080](http://localhost:8080). http://git-wip-us.apache.org/repos/asf/zeppelin/blob/68cb6761/docs/setup/storage/storage.md ---------------------------------------------------------------------- diff --git a/docs/setup/storage/storage.md b/docs/setup/storage/storage.md index 6f2ace4..4d45b65 100644 --- a/docs/setup/storage/storage.md +++ b/docs/setup/storage/storage.md @@ -46,7 +46,7 @@ By default, only first two of them will be automatically kept in sync by Zeppeli To enable versioning for all your local notebooks though a standard Git repository - uncomment the next property in `zeppelin-site.xml` in order to use GitNotebookRepo class: -``` +```xml <property> <name>zeppelin.notebook.storage</name> <value>org.apache.zeppelin.notebook.repo.GitNotebookRepo</value> @@ -61,7 +61,7 @@ To enable versioning for all your local notebooks though a standard Git reposito Notes may be stored in hadoop compatible file system such as hdfs, so that multiple Zeppelin instances can share the same notes. It supports all the versions of hadoop 2.x. If you use `FileSystemNotebookRepo`, then `zeppelin.notebook.dir` is the path on the hadoop compatible file system. And you need to specify `HADOOP_CONF_DIR` in `zeppelin-env.sh` so that zeppelin can find the right hadoop configuration files. If your hadoop cluster is kerberized, then you need to specify `zeppelin.server.kerberos.keytab` and `zeppelin.server.kerberos.principal` -``` +```xml <property> <name>zeppelin.notebook.storage</name> <value>org.apache.zeppelin.notebook.repo.FileSystemNotebookRepo</value> @@ -90,14 +90,14 @@ s3://bucket_name/username/notebook-id/ Configure by setting environment variables in the file **zeppelin-env.sh**: -``` -export ZEPPELIN_NOTEBOOK_S3_BUCKET = bucket_name -export ZEPPELIN_NOTEBOOK_S3_USER = username +```bash +export ZEPPELIN_NOTEBOOK_S3_BUCKET=bucket_name +export ZEPPELIN_NOTEBOOK_S3_USER=username ``` Or using the file **zeppelin-site.xml** uncomment and complete the S3 settings: -``` +```xml <property> <name>zeppelin.notebook.s3.bucket</name> <value>bucket_name</value> @@ -112,7 +112,7 @@ Or using the file **zeppelin-site.xml** uncomment and complete the S3 settings: Uncomment the next property for use S3NotebookRepo class: -``` +```xml <property> <name>zeppelin.notebook.storage</name> <value>org.apache.zeppelin.notebook.repo.S3NotebookRepo</value> @@ -122,7 +122,7 @@ Uncomment the next property for use S3NotebookRepo class: Comment out the next property to disable local git notebook storage (the default): -``` +```xml <property> <name>zeppelin.notebook.storage</name> <value>org.apache.zeppelin.notebook.repo.GitNotebookRepo</value> @@ -136,13 +136,13 @@ Comment out the next property to disable local git notebook storage (the default To use an [AWS KMS](https://aws.amazon.com/kms/) encryption key to encrypt notebooks, set the following environment variable in the file **zeppelin-env.sh**: -``` -export ZEPPELIN_NOTEBOOK_S3_KMS_KEY_ID = kms-key-id +```bash +export ZEPPELIN_NOTEBOOK_S3_KMS_KEY_ID=kms-key-id ``` Or using the following setting in **zeppelin-site.xml**: -``` +```xml <property> <name>zeppelin.notebook.s3.kmsKeyID</name> <value>AWS-KMS-Key-UUID</value> @@ -152,13 +152,13 @@ Or using the following setting in **zeppelin-site.xml**: In order to set custom KMS key region, set the following environment variable in the file **zeppelin-env.sh**: -``` -export ZEPPELIN_NOTEBOOK_S3_KMS_KEY_REGION = kms-key-region +```bash +export ZEPPELIN_NOTEBOOK_S3_KMS_KEY_REGION=kms-key-region ``` Or using the following setting in **zeppelin-site.xml**: -``` +```xml <property> <name>zeppelin.notebook.s3.kmsKeyRegion</name> <value>target-region</value> @@ -172,13 +172,13 @@ Format of `target-region` is described in more details [here](http://docs.aws.am You may use a custom [``EncryptionMaterialsProvider``](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/s3/model/EncryptionMaterialsProvider.html) class as long as it is available in the classpath and able to initialize itself from system properties or another mechanism. To use this, set the following environment variable in the file **zeppelin-env.sh**: -``` -export ZEPPELIN_NOTEBOOK_S3_EMP = class-name +```bash +export ZEPPELIN_NOTEBOOK_S3_EMP=class-name ``` Or using the following setting in **zeppelin-site.xml**: -``` +```xml <property> <name>zeppelin.notebook.s3.encryptionMaterialsProvider</name> <value>provider implementation class name</value> @@ -189,13 +189,13 @@ Or using the following setting in **zeppelin-site.xml**: To request server-side encryption of notebooks, set the following environment variable in the file **zeppelin-env.sh**: -``` -export ZEPPELIN_NOTEBOOK_S3_SSE = true +```bash +export ZEPPELIN_NOTEBOOK_S3_SSE=true ``` Or using the following setting in **zeppelin-site.xml**: -``` +```xml <property> <name>zeppelin.notebook.s3.sse</name> <value>true</value> @@ -210,7 +210,7 @@ Using `AzureNotebookRepo` you can connect your Zeppelin with your Azure account First of all, input your `AccountName`, `AccountKey`, and `Share Name` in the file **zeppelin-site.xml** by commenting out and completing the next properties: -``` +```xml <property> <name>zeppelin.notebook.azure.connectionString</name> <value>DefaultEndpointsProtocol=https;AccountName=<accountName>;AccountKey=<accountKey></value> @@ -226,7 +226,7 @@ First of all, input your `AccountName`, `AccountKey`, and `Share Name` in the fi Secondly, you can initialize `AzureNotebookRepo` class in the file **zeppelin-site.xml** by commenting the next property: -``` +```xml <property> <name>zeppelin.notebook.storage</name> <value>org.apache.zeppelin.notebook.repo.GitNotebookRepo</value> @@ -236,7 +236,7 @@ Secondly, you can initialize `AzureNotebookRepo` class in the file **zeppelin-si and commenting out: -``` +```xml <property> <name>zeppelin.notebook.storage</name> <value>org.apache.zeppelin.notebook.repo.AzureNotebookRepo</value> @@ -246,7 +246,7 @@ and commenting out: In case you want to use simultaneously your local git storage with Azure storage use the following property instead: - ``` + ```xml <property> <name>zeppelin.notebook.storage</name> <value>org.apache.zeppelin.notebook.repo.GitNotebookRepo, apache.zeppelin.notebook.repo.AzureNotebookRepo</value> @@ -256,7 +256,7 @@ In case you want to use simultaneously your local git storage with Azure storage Optionally, you can specify Azure folder structure name in the file **zeppelin-site.xml** by commenting out the next property: - ``` + ```xml <property> <name>zeppelin.notebook.azure.user</name> <value>user</value> @@ -271,7 +271,7 @@ Using `GCSNotebookRepo` you can connect Zeppelin with Google Cloud Storage using First, choose a GCS path under which to store notebooks. -``` +```xml <property> <name>zeppelin.notebook.gcs.dir</name> <value></value> @@ -284,7 +284,7 @@ First, choose a GCS path under which to store notebooks. Then, initialize the `GCSNotebookRepo` class in the file **zeppelin-site.xml** by commenting the next property: -``` +```xml <property> <name>zeppelin.notebook.storage</name> <value>org.apache.zeppelin.notebook.repo.GitNotebookRepo</value> @@ -294,7 +294,7 @@ Then, initialize the `GCSNotebookRepo` class in the file **zeppelin-site.xml** b and commenting out: -``` +```xml <property> <name>zeppelin.notebook.storage</name> <value>org.apache.zeppelin.notebook.repo.GCSNotebookRepo</value> @@ -304,7 +304,7 @@ and commenting out: Or, if you want to simultaneously use your local git storage with GCS, use the following property instead: - ``` +```xml <property> <name>zeppelin.notebook.storage</name> <value>org.apache.zeppelin.notebook.repo.GitNotebookRepo,org.apache.zeppelin.notebook.repo.GCSNotebookRepo</value> @@ -360,7 +360,7 @@ export GOOGLE_APPLICATION_CREDENTIALS=/path/to/my/key.json ZeppelinHub storage layer allows out of the box connection of Zeppelin instance with your ZeppelinHub account. First of all, you need to either comment out the following property in **zeppelin-site.xml**: -``` +```xml <!-- For connecting your Zeppelin with ZeppelinHub --> <!-- <property> @@ -373,15 +373,15 @@ ZeppelinHub storage layer allows out of the box connection of Zeppelin instance or set the environment variable in the file **zeppelin-env.sh**: -``` +```bash export ZEPPELIN_NOTEBOOK_STORAGE="org.apache.zeppelin.notebook.repo.GitNotebookRepo, org.apache.zeppelin.notebook.repo.zeppelinhub.ZeppelinHubRepo" ``` Secondly, you need to set the environment variables in the file **zeppelin-env.sh**: -``` -export ZEPPELINHUB_API_TOKEN = ZeppelinHub token -export ZEPPELINHUB_API_ADDRESS = address of ZeppelinHub service (e.g. https://www.zeppelinhub.com) +```bash +export ZEPPELINHUB_API_TOKEN=ZeppelinHub token +export ZEPPELINHUB_API_ADDRESS=address of ZeppelinHub service (e.g. https://www.zeppelinhub.com) ``` You can get more information on generating `token` and using authentication on the corresponding [help page](http://help.zeppelinhub.com/zeppelin_integration/#add-a-new-zeppelin-instance-and-generate-a-token). @@ -400,7 +400,7 @@ You can use MongoDB as notebook storage by editting `zeppelin-env.sh` or `zeppel #### (Method 1) by editting `zeppelin-env.sh` Add a line below to `$ZEPPELIN_HOME/conf/zeppelin-env.sh`: -```sh +```bash export ZEPPELIN_NOTEBOOK_STORAGE=org.apache.zeppelin.notebook.repo.MongoNotebookRepo ``` @@ -459,7 +459,7 @@ By setting `ZEPPELIN_NOTEBOOK_MONGO_AUTOIMPORT` as `true` (default `false`), you To enable GitHub tracking, uncomment the following properties in `zeppelin-site.xml` -```sh +```xml <property> <name>zeppelin.notebook.git.remote.url</name> <value></value> @@ -487,11 +487,11 @@ To enable GitHub tracking, uncomment the following properties in `zeppelin-site. And set the `zeppelin.notebook.storage` propery to `org.apache.zeppelin.notebook.repo.GitHubNotebookRepo` -```sh +```xml <property> <name>zeppelin.notebook.storage</name> <value>org.apache.zeppelin.notebook.repo.GitHubNotebookRepo</value> </property> ``` -The access token could be obtained by following the steps on this link https://github.com/settings/tokens. \ No newline at end of file +The access token could be obtained by following the steps on this link https://github.com/settings/tokens. http://git-wip-us.apache.org/repos/asf/zeppelin/blob/68cb6761/docs/usage/display_system/angular_backend.md ---------------------------------------------------------------------- diff --git a/docs/usage/display_system/angular_backend.md b/docs/usage/display_system/angular_backend.md index ff29102..2b9b094 100644 --- a/docs/usage/display_system/angular_backend.md +++ b/docs/usage/display_system/angular_backend.md @@ -99,6 +99,7 @@ In this section, we will introduce a simpler and more intuitive way of using **A Here are some usages. ### Import + ```scala // In notebook scope import org.apache.zeppelin.display.angular.notebookscope._ http://git-wip-us.apache.org/repos/asf/zeppelin/blob/68cb6761/docs/usage/display_system/basic.md ---------------------------------------------------------------------- diff --git a/docs/usage/display_system/basic.md b/docs/usage/display_system/basic.md index d66c59d..5080fff 100644 --- a/docs/usage/display_system/basic.md +++ b/docs/usage/display_system/basic.md @@ -119,7 +119,7 @@ This kind of graph can be easily *flatten* in order to support other visualizati An example of a simple graph -``` +```scala %spark print(s""" %network { @@ -146,7 +146,7 @@ that will look like: A little more complex graph: -``` +```scala %spark print(s""" %network { @@ -161,4 +161,4 @@ print(s""" that will look like: -<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/screenshots/display_complex_network.png" /> \ No newline at end of file +<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/screenshots/display_complex_network.png" /> http://git-wip-us.apache.org/repos/asf/zeppelin/blob/68cb6761/docs/usage/interpreter/dynamic_loading.md ---------------------------------------------------------------------- diff --git a/docs/usage/interpreter/dynamic_loading.md b/docs/usage/interpreter/dynamic_loading.md index 425abf9..a02e960 100644 --- a/docs/usage/interpreter/dynamic_loading.md +++ b/docs/usage/interpreter/dynamic_loading.md @@ -55,7 +55,7 @@ For example, if you want to load `markdown` interpreter to your Zeppelin, the pa http://127.0.0.1:8080/api/interpreter/load/md/markdown ``` -``` +```json { "artifact": "org.apache.zeppelin:zeppelin-markdown:0.6.0-SNAPSHOT", "className": "org.apache.zeppelin.markdown.Markdown", http://git-wip-us.apache.org/repos/asf/zeppelin/blob/68cb6761/docs/usage/interpreter/installation.md ---------------------------------------------------------------------- diff --git a/docs/usage/interpreter/installation.md b/docs/usage/interpreter/installation.md index 7e1cb80..becf078 100644 --- a/docs/usage/interpreter/installation.md +++ b/docs/usage/interpreter/installation.md @@ -31,19 +31,19 @@ If you downloaded `netinst` binary package, you need to install by using below c #### Install all community managed interpreters -``` +```bash ./bin/install-interpreter.sh --all ``` #### Install specific interpreters -``` +```bash ./bin/install-interpreter.sh --name md,shell,jdbc,python ``` You can get full list of community managed interpreters by running -``` +```bash ./bin/install-interpreter.sh --list ``` @@ -80,7 +80,7 @@ Zeppelin support both Scala 2.10 and 2.11 for several interpreters as below: If you install one of these interpreters only with `--name` option, installer will download interpreter built with Scala 2.11 by default. If you want to specify Scala version, you will need to add `--artifact` option. Here is the example of installing flink interpreter built with Scala 2.10. -``` +```bash ./bin/install-interpreter.sh --name flink --artifact org.apache.zeppelin:zeppelin-flink_2.10:0.8.0 ``` @@ -90,7 +90,8 @@ It would pick up the right scala specific interpreter for the spark distribution Here's the command to install spark interpreter -``` +```bash +rm -rf ./interpreter/spark ./bin/install-interpreter.sh --name spark --artifact org.apache.zeppelin:spark-interpreter:0.8.0 ``` @@ -103,7 +104,7 @@ You can also install 3rd party interpreters located in the maven repository by u #### Install 3rd party interpreters -``` +```bash ./bin/install-interpreter.sh --name interpreter1 --artifact groupId1:artifact1:version1 ``` @@ -113,7 +114,7 @@ After restart Zeppelin, then [create interpreter setting](./overview.html#what-i #### Install multiple 3rd party interpreters at once -``` +```bash ./bin/install-interpreter.sh --name interpreter1,interpreter2 --artifact groupId1:artifact1:version1,groupId2:artifact2:version2 ``` http://git-wip-us.apache.org/repos/asf/zeppelin/blob/68cb6761/docs/usage/interpreter/overview.md ---------------------------------------------------------------------- diff --git a/docs/usage/interpreter/overview.md b/docs/usage/interpreter/overview.md index 035c381..5b567c7 100644 --- a/docs/usage/interpreter/overview.md +++ b/docs/usage/interpreter/overview.md @@ -105,10 +105,10 @@ For more information, check [Interpreter Binding Mode](./interpreter_binding_mod Zeppelin users can start interpreter thread embedded in their service. This will provide flexibility to user to start interpreter on remote host. To start interpreter along with your service you have to create an instance of ``RemoteInterpreterServer`` and start it as follows: -``` +```java RemoteInterpreterServer interpreter=new RemoteInterpreterServer(3678); // Here, 3678 is the port on which interpreter will listen. -interpreter.start() +interpreter.start(); ``` http://git-wip-us.apache.org/repos/asf/zeppelin/blob/68cb6761/docs/usage/interpreter/user_impersonation.md ---------------------------------------------------------------------- diff --git a/docs/usage/interpreter/user_impersonation.md b/docs/usage/interpreter/user_impersonation.md index 9b08cf8..28e2814 100644 --- a/docs/usage/interpreter/user_impersonation.md +++ b/docs/usage/interpreter/user_impersonation.md @@ -35,7 +35,7 @@ user2 = password2, role2 #### 2. Enable password-less ssh for the user you want to impersonate (say user1). -``` +```bash adduser user1 #ssh-keygen (optional if you don't already have generated ssh-key. ssh user1@localhost mkdir -p .ssh @@ -44,14 +44,14 @@ cat ~/.ssh/id_rsa.pub | ssh user1@localhost 'cat >> .ssh/authorized_keys' Alternatively instead of password-less, user can override ZEPPELIN_IMPERSONATE_CMD in zeppelin-env.sh -``` +```bash export ZEPPELIN_IMPERSONATE_CMD='sudo -H -u ${ZEPPELIN_IMPERSONATE_USER} bash -c ' ``` #### 4. Restart zeppelin server. -``` +```bash # for OSX, linux bin/zeppelin-daemon restart @@ -76,7 +76,7 @@ Go to interpreter setting page, and enable "User Impersonate" in any of the inte #### 6. Test with a simple paragraph -``` +```bash %sh whoami ``` http://git-wip-us.apache.org/repos/asf/zeppelin/blob/68cb6761/docs/usage/other_features/customizing_homepage.md ---------------------------------------------------------------------- diff --git a/docs/usage/other_features/customizing_homepage.md b/docs/usage/other_features/customizing_homepage.md index 35eb67b..52b9d4b 100644 --- a/docs/usage/other_features/customizing_homepage.md +++ b/docs/usage/other_features/customizing_homepage.md @@ -58,7 +58,7 @@ or ```zeppelin.notebook.homescreen.hide``` property to hide the new note from th ### Restart Zeppelin Restart your Zeppelin server -``` +```bash ./bin/zeppelin-daemon stop ./bin/zeppelin-daemon start ``` http://git-wip-us.apache.org/repos/asf/zeppelin/blob/68cb6761/docs/usage/other_features/zeppelin_context.md ---------------------------------------------------------------------- diff --git a/docs/usage/other_features/zeppelin_context.md b/docs/usage/other_features/zeppelin_context.md index 5a77727..ced400a 100644 --- a/docs/usage/other_features/zeppelin_context.md +++ b/docs/usage/other_features/zeppelin_context.md @@ -45,7 +45,7 @@ predefined variable `z`. In the Apache Spark interpreter, the zeppelin-context provides a `show` method, which, using Zeppelin's `table` feature, can be used to nicely display a Spark DataFrame: -``` +```scala df = spark.read.csv('/path/to/csv') z.show(df) ``` @@ -186,12 +186,14 @@ interpolated into a paragraph text by using such a pattern containing the object The following example shows one use of this facility: ####In Scala cell: -``` + +```scala z.put("minAge", 35) ``` ####In later SQL cell: -``` + +```sql %sql select * from members where age >= {minAge} ``` @@ -205,7 +207,7 @@ object interpolation mechanism. For these cases an escaping mechanism is availab doubled braces {{ and }} should be used. The following example shows the use of {{ and }} for passing a regular expression containing just { and } into the paragraph text. -``` +```sql %sql select * from members where name rlike '[aeiou]{{3}}' ```
