Repository: accumulo Updated Branches: refs/heads/master 37ad8f505 -> d4d7d0920
ACCUMULO-4530 Stop generating docs/config.html * Configuration docs can be found in appendix of user manual * Updated all pointers to config.html to user manual instead * Removed code used to generate HTML file Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/d4d7d092 Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/d4d7d092 Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/d4d7d092 Branch: refs/heads/master Commit: d4d7d0920c98a2f89882f1c4d9051e1a18fa9dca Parents: 37ad8f5 Author: Mike Walch <mwa...@apache.org> Authored: Fri Dec 2 13:42:12 2016 -0500 Committer: Mike Walch <mwa...@apache.org> Committed: Tue Dec 6 10:38:39 2016 -0500 ---------------------------------------------------------------------- assemble/libexec/templates/accumulo-site.xml | 5 +- assemble/src/main/assemblies/component.xml | 9 -- .../accumulo/core/conf/ConfigurationDocGen.java | 149 +------------------ .../accumulo/core/conf/config-header.html | 88 ----------- .../test/resources/crypto-off-accumulo-site.xml | 9 -- .../test/resources/crypto-on-accumulo-site.xml | 13 +- ...rypto-on-no-key-encryption-accumulo-site.xml | 9 -- docs/pom.xml | 15 -- docs/src/main/resources/administration.html | 2 +- docs/src/main/resources/index.html | 1 - test/src/main/resources/conf/accumulo-site.xml | 9 -- 11 files changed, 9 insertions(+), 300 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/accumulo/blob/d4d7d092/assemble/libexec/templates/accumulo-site.xml ---------------------------------------------------------------------- diff --git a/assemble/libexec/templates/accumulo-site.xml b/assemble/libexec/templates/accumulo-site.xml index ff490b1..a1f4153 100644 --- a/assemble/libexec/templates/accumulo-site.xml +++ b/assemble/libexec/templates/accumulo-site.xml @@ -18,9 +18,8 @@ <?xml-stylesheet type="text/xsl" href="configuration.xsl"?> <configuration> - <!-- Put your site-specific accumulo configurations here. The available configuration values along with their defaults are documented in docs/config.html Unless - you are simply testing at your workstation, you will most definitely need to change the three entries below. --> - + <!-- This is the main configuration file for Apache Accumulo. Available configuration properties + (and their default values) can be found in the user manual (docs/accumulo_user_manual.html). --> <property> <name>instance.volumes</name> <value></value> http://git-wip-us.apache.org/repos/asf/accumulo/blob/d4d7d092/assemble/src/main/assemblies/component.xml ---------------------------------------------------------------------- diff --git a/assemble/src/main/assemblies/component.xml b/assemble/src/main/assemblies/component.xml index c384e14..83db9e8 100644 --- a/assemble/src/main/assemblies/component.xml +++ b/assemble/src/main/assemblies/component.xml @@ -135,15 +135,6 @@ </includes> </fileSet> <fileSet> - <directory>../docs/target</directory> - <outputDirectory>docs</outputDirectory> - <directoryMode>0755</directoryMode> - <fileMode>0644</fileMode> - <includes> - <include>config.html</include> - </includes> - </fileSet> - <fileSet> <directory>conf</directory> <directoryMode>0755</directoryMode> <fileMode>0755</fileMode> http://git-wip-us.apache.org/repos/asf/accumulo/blob/d4d7d092/core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java b/core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java index 1c34b99..c128c80 100644 --- a/core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java +++ b/core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java @@ -86,136 +86,6 @@ class ConfigurationDocGen { } - private class HTML extends Format { - private boolean highlight; - - private void beginRow() { - doc.println(startTag("tr", highlight ? "class='highlight'" : null)); - highlight = !highlight; - } - - @Override - void beginSection(String section) { - doc.println(t("h1", section, null)); - highlight = true; - doc.println("<table>"); - } - - private String t(String tag, String cell, String options) { - return startTag(tag, options) + cell + "</" + tag + ">"; - } - - private void cellData(String cell, String options) { - doc.println(t("td", cell, options)); - } - - private void columnNames(String... names) { - beginRow(); - for (String s : names) - doc.println(t("th", s, null)); - endRow(); - } - - private void endRow() { - doc.println("</tr>"); - } - - @Override - void endSection() { - doc.println("</table>"); - } - - @Override - String getExt() { - return "html"; - } - - @Override - void pageFooter() { - doc.println("</body>"); - doc.println("</html>"); - } - - @Override - void propertyQuickLinks() { - doc.println("<p>Jump to: "); - String delimiter = ""; - for (Property prefix : prefixes) { - if (!prefix.isExperimental()) { - doc.print(delimiter + "<a href='#" + prefix.name() + "'>" + prefix.getKey() + "*</a>"); - delimiter = " | "; - } - } - doc.println("</p>"); - } - - @Override - void prefixSection(Property prefix) { - beginRow(); - doc.println(t("td", t("span", prefix.getKey() + '*', "id='" + prefix.name() + "' class='large'"), "colspan='5'" - + (prefix.isDeprecated() ? " class='deprecated'" : ""))); - endRow(); - beginRow(); - doc.println(t("td", (prefix.isDeprecated() ? t("b", t("i", "Deprecated. ", null), null) : "") + sanitize(prefix.getDescription()), "colspan='5'" - + (prefix.isDeprecated() ? " class='deprecated'" : ""))); - endRow(); - - switch (prefix) { - case TABLE_CONSTRAINT_PREFIX: - break; - case TABLE_ITERATOR_PREFIX: - break; - case TABLE_LOCALITY_GROUP_PREFIX: - break; - case TABLE_COMPACTION_STRATEGY_PREFIX: - break; - default: - columnNames("Property", "Type", "ZooKeeper Mutable", "Default Value", "Description"); - break; - } - } - - @Override - void property(Property prefix, Property prop) { - boolean isDeprecated = prefix.isDeprecated() || prop.isDeprecated(); - if (prop.getKey().startsWith(prefix.getKey())) { - beginRow(); - cellData(prop.getKey(), isDeprecated ? "class='deprecated'" : null); - cellData("<b><a href='#" + prop.getType().name() + "'>" + prop.getType().toString().replaceAll(" ", " ") + "</a></b>", - isDeprecated ? "class='deprecated'" : null); - cellData(isZooKeeperMutable(prop), isDeprecated ? "class='deprecated'" : null); - cellData("<pre>" + (prop.getRawDefaultValue().isEmpty() ? " " : sanitize(prop.getRawDefaultValue().replaceAll(" ", " "))) + "</pre>", - isDeprecated ? "class='deprecated'" : null); - cellData((isDeprecated ? "<b><i>Deprecated.</i></b> " : "") + sanitize(prop.getDescription()), isDeprecated ? "class='deprecated'" : null); - endRow(); - } - - } - - @Override - void propertyTypeDescriptions() { - columnNames("Property Type", "Description"); - for (PropertyType type : PropertyType.values()) { - if (type == PropertyType.PREFIX) - continue; - beginRow(); - cellData("<h3 id='" + type.name() + "'>" + type + "</h3>", null); - cellData(type.getFormatDescription(), null); - endRow(); - } - } - - @Override - String sanitize(String str) { - return str.replace("&", "&").replace("<", "<").replace(">", ">").replaceAll("(?:\r\n|\r|\n)", "<br />"); - } - - private String startTag(String tag, String options) { - return "<" + tag + (options != null ? " " + options : "") + ">"; - } - - } - private class Asciidoc extends Format { @Override void beginSection(String section) { @@ -303,7 +173,7 @@ class ConfigurationDocGen { private final TreeMap<String,Property> sortedProps; - ConfigurationDocGen(PrintStream doc) { + private ConfigurationDocGen(PrintStream doc) { this.doc = doc; this.prefixes = new ArrayList<>(); this.sortedProps = new TreeMap<>(); @@ -329,7 +199,6 @@ class ConfigurationDocGen { doc.print(new String(buffer, 0, n, UTF_8)); } catch (IOException e) { log.debug("Encountered IOException while reading InputStream in appendResource().", e); - return; } finally { try { data.close(); @@ -348,31 +217,23 @@ class ConfigurationDocGen { return "yes"; } - void generateHtml() { - new HTML().generate(); - } - - void generateAsciidoc() { + private void generateAsciidoc() { new Asciidoc().generate(); } /** - * Generates documentation for conf/accumulo-site.xml file usage. Arguments are: "--generate-doc", file to write to. + * Generates documentation for conf/accumulo-site.xml file usage. Arguments are: "--generate-asciidoc filename" * * @param args * command-line arguments - * * @throws IllegalArgumentException * if args is invalid */ public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException { - if (args.length == 2 && args[0].equals("--generate-html")) { - new ConfigurationDocGen(new PrintStream(args[1], UTF_8.name())).generateHtml(); - } else if (args.length == 2 && args[0].equals("--generate-asciidoc")) { + if (args.length == 2 && args[0].equals("--generate-asciidoc")) { new ConfigurationDocGen(new PrintStream(args[1], UTF_8.name())).generateAsciidoc(); } else { - throw new IllegalArgumentException("Usage: " + ConfigurationDocGen.class.getName() + " --generate-html <filename> | --generate-asciidoc <filename>"); + throw new IllegalArgumentException("Usage: " + ConfigurationDocGen.class.getName() + " --generate-asciidoc <filename>"); } } - } http://git-wip-us.apache.org/repos/asf/accumulo/blob/d4d7d092/core/src/main/resources/org/apache/accumulo/core/conf/config-header.html ---------------------------------------------------------------------- diff --git a/core/src/main/resources/org/apache/accumulo/core/conf/config-header.html b/core/src/main/resources/org/apache/accumulo/core/conf/config-header.html deleted file mode 100644 index 49291fc..0000000 --- a/core/src/main/resources/org/apache/accumulo/core/conf/config-header.html +++ /dev/null @@ -1,88 +0,0 @@ -<!DOCTYPE html> -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <title>Accumulo Configuration</title> - <link rel='stylesheet' type='text/css' href='documentation.css' media='screen'/> - </head> - <body> - <h1>Configuration Management</h1> - <p>All accumulo properties have a default value in the source code. Properties can also be set - in accumulo-site.xml and in zookeeper on per-table or system-wide basis. If properties are set in more than one location, - accumulo will choose the property with the highest precedence. This order of precedence is described - below (from highest to lowest):</p> - <table> - <tr><th>Location</th><th>Description</th></tr> - <tr class='highlight'><td><b>Zookeeper<br />table properties</b></td> - <td>Table properties are applied to the entire cluster when set in zookeeper using the accumulo API or shell. While table properties take precedent over system properties, both will override properties set in accumulo-site.xml<br /><br /> - Table properties consist of all properties with the table.* prefix. Table properties are configured on a per-table basis using the following shell commmand: - <pre>config -t TABLE -s PROPERTY=VALUE</pre></td> - </tr> - <tr><td><b>Zookeeper<br />system properties</b></td> - <td>System properties are applied to the entire cluster when set in zookeeper using the accumulo API or shell. System properties consist of all properties with a 'yes' in the 'Zookeeper Mutable' column in the table below. They are set with the following shell command: - <pre>config -s PROPERTY=VALUE</pre> - If a table.* property is set using this method, the value will apply to all tables except those configured on per-table basis (which have higher precedence).<br /><br /> - While most system properties take effect immediately, some require a restart of the process which is indicated in 'Zookeeper Mutable'.</td> - </tr> - <tr class='highlight'><td><b>accumulo-site.xml</b></td> - <td>Accumulo processes (master, tserver, etc) read their local accumulo-site.xml on start up. Therefore, changes made to accumulo-site.xml must rsynced across the cluster and processes must be restarted to apply changes.<br /><br /> - Certain properties (indicated by a 'no' in 'Zookeeper Mutable') cannot be set in zookeeper and only set in this file. The accumulo-site.xml also allows you to configure tablet servers with different settings.</td> - </tr> - <tr><td><b>Default</b></td> - <td>All properties have a default value in the source code. This value has the lowest precedence and is overriden if set in accumulo-site.xml or zookeeper.<br /><br />While the default value is usually optimal, there are cases where a change can increase query and ingest performance.</td> - </tr> - </table> - - <p>The 'config' command in the shell allows you to view the current system configuration. You can also use the '-t' option to view a table's configuration as below: - - <pre> - $ ./bin/accumulo shell -u root - Enter current password for 'root'@'ac14': ****** - - Shell - Apache Accumulo Interactive Shell - - - - version: 1.5.0 - - instance name: ac14 - - instance id: 4f48fa03-f692-43ce-ae03-94c9ea8b7181 - - - - type 'help' for a list of available commands - - - root@ac13> config -t foo - ---------+---------------------------------------------+------------------------------------------------------ - SCOPE | NAME | VALUE - ---------+---------------------------------------------+------------------------------------------------------ - default | table.balancer ............................ | org.apache.accumulo.server.master.balancer.DefaultLoadBalancer - default | table.bloom.enabled ....................... | false - default | table.bloom.error.rate .................... | 0.5% - default | table.bloom.hash.type ..................... | murmur - default | table.bloom.key.functor ................... | org.apache.accumulo.core.file.keyfunctor.RowFunctor - default | table.bloom.load.threshold ................ | 1 - default | table.bloom.size .......................... | 1048576 - default | table.cache.block.enable .................. | false - default | table.cache.index.enable .................. | false - default | table.compaction.major.everything.at ...... | 19700101000000GMT - default | table.compaction.major.everything.idle .... | 1h - default | table.compaction.major.ratio .............. | 1.3 - site | @override .............................. | 1.4 - system | @override .............................. | 1.5 - table | @override .............................. | 1.6 - default | table.compaction.minor.idle ............... | 5m - default | table.compaction.minor.logs.threshold ..... | 3 - default | table.failures.ignore ..................... | false - </pre> - http://git-wip-us.apache.org/repos/asf/accumulo/blob/d4d7d092/core/src/test/resources/crypto-off-accumulo-site.xml ---------------------------------------------------------------------- diff --git a/core/src/test/resources/crypto-off-accumulo-site.xml b/core/src/test/resources/crypto-off-accumulo-site.xml index 90efd68..7896544 100644 --- a/core/src/test/resources/crypto-off-accumulo-site.xml +++ b/core/src/test/resources/crypto-off-accumulo-site.xml @@ -18,15 +18,6 @@ <?xml-stylesheet type="text/xsl" href="configuration.xsl"?> <configuration> - <!-- - Put your site-specific accumulo configurations here. - - The available configuration values along with their defaults - are documented in docs/config.html - - Unless you are simply testing at your workstation, you will most - definitely need to change the three entries below. - --> <property> <name>instance.zookeeper.host</name> http://git-wip-us.apache.org/repos/asf/accumulo/blob/d4d7d092/core/src/test/resources/crypto-on-accumulo-site.xml ---------------------------------------------------------------------- diff --git a/core/src/test/resources/crypto-on-accumulo-site.xml b/core/src/test/resources/crypto-on-accumulo-site.xml index 6025824..ebfc9ae 100644 --- a/core/src/test/resources/crypto-on-accumulo-site.xml +++ b/core/src/test/resources/crypto-on-accumulo-site.xml @@ -18,16 +18,7 @@ <?xml-stylesheet type="text/xsl" href="configuration.xsl"?> <configuration> - <!-- - Put your site-specific accumulo configurations here. - - The available configuration values along with their defaults - are documented in docs/config.html - - Unless you are simply testing at your workstation, you will most - definitely need to change the three entries below. - --> - + <property> <name>instance.zookeeper.host</name> <value>localhost:2181</value> @@ -131,6 +122,4 @@ <value>AES/ECB/NoPadding</value> </property> - - </configuration> http://git-wip-us.apache.org/repos/asf/accumulo/blob/d4d7d092/core/src/test/resources/crypto-on-no-key-encryption-accumulo-site.xml ---------------------------------------------------------------------- diff --git a/core/src/test/resources/crypto-on-no-key-encryption-accumulo-site.xml b/core/src/test/resources/crypto-on-no-key-encryption-accumulo-site.xml index 888aa1d..d980783 100644 --- a/core/src/test/resources/crypto-on-no-key-encryption-accumulo-site.xml +++ b/core/src/test/resources/crypto-on-no-key-encryption-accumulo-site.xml @@ -18,15 +18,6 @@ <?xml-stylesheet type="text/xsl" href="configuration.xsl"?> <configuration> - <!-- - Put your site-specific accumulo configurations here. - - The available configuration values along with their defaults - are documented in docs/config.html - - Unless you are simply testing at your workstation, you will most - definitely need to change the three entries below. - --> <property> <name>instance.zookeeper.host</name> http://git-wip-us.apache.org/repos/asf/accumulo/blob/d4d7d092/docs/pom.xml ---------------------------------------------------------------------- diff --git a/docs/pom.xml b/docs/pom.xml index 0ef4b5f..d6a5aaa 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -102,21 +102,6 @@ </configuration> </execution> <execution> - <id>config-html</id> - <goals> - <goal>java</goal> - </goals> - <phase>compile</phase> - <configuration> - <mainClass>org.apache.accumulo.core.conf.ConfigurationDocGen</mainClass> - <classpathScope>compile</classpathScope> - <arguments> - <argument>--generate-html</argument> - <argument>${project.build.directory}/config.html</argument> - </arguments> - </configuration> - </execution> - <execution> <id>config-appendix</id> <goals> <goal>java</goal> http://git-wip-us.apache.org/repos/asf/accumulo/blob/d4d7d092/docs/src/main/resources/administration.html ---------------------------------------------------------------------- diff --git a/docs/src/main/resources/administration.html b/docs/src/main/resources/administration.html index 39a46ff..1782171 100644 --- a/docs/src/main/resources/administration.html +++ b/docs/src/main/resources/administration.html @@ -110,7 +110,7 @@ settings, for example, for a table while accumulo is running. <p>Per-table configuration settings override system settings. -<p>See the possible configuration options and their default values <a href='config.html'>here</a> +<p>See the possible configuration options and their default values in the user manual. <h3>Managing system resources</h3> http://git-wip-us.apache.org/repos/asf/accumulo/blob/d4d7d092/docs/src/main/resources/index.html ---------------------------------------------------------------------- diff --git a/docs/src/main/resources/index.html b/docs/src/main/resources/index.html index cc4ecb7..aca3bb2 100644 --- a/docs/src/main/resources/index.html +++ b/docs/src/main/resources/index.html @@ -28,7 +28,6 @@ <li><a href=combiners.html>Combiners</a></li> <li><a href=constraints.html>Constraints</a></li> <li><a href=bulkIngest.html>Bulk Ingest</a></li> -<li><a href=config.html>Configuration</a></li> <li><a href=isolation.html>Isolation</a></li> <li><a href=lgroups.html>Locality Groups</a></li> <li><a href=timestamps.html>Timestamps</a></li> http://git-wip-us.apache.org/repos/asf/accumulo/blob/d4d7d092/test/src/main/resources/conf/accumulo-site.xml ---------------------------------------------------------------------- diff --git a/test/src/main/resources/conf/accumulo-site.xml b/test/src/main/resources/conf/accumulo-site.xml index 23b47bf..a9d1416 100644 --- a/test/src/main/resources/conf/accumulo-site.xml +++ b/test/src/main/resources/conf/accumulo-site.xml @@ -18,15 +18,6 @@ <?xml-stylesheet type="text/xsl" href="configuration.xsl"?> <configuration> - <!-- - Put your site-specific accumulo configurations here. - - The available configuration values along with their defaults - are documented in docs/config.html - - Unless you are simply testing at your workstation, you will most - definitely need to change the three entries below. - --> <property> <name>instance.zookeeper.host</name>
