Correct case of acronyms (apache#2920)

* Correct dag to DAG

* Correct hdfs to HDFS

* Correct s3 to S3

* Correct ram to RAM

* Add vagrant/.vagrant/ to .gitignore

* Correct jvm to JVM

* Correct apiserver to API server

* Correct 'api server' to 'API server'

* Correct api to API

* Correct cpu to CPU

* Fix error made while correcting documentation

* Correct acronyms

 * ram, Ram → RAM
 * Cpu → CPU

Author: Code0x58

.gitignore

@@ -134,4 +134,7 @@ website/public/
 .vscode
 
 # integration_test
-results/
+results/
+
+# Vagrant
+vagrant/.vagrant/

WORKSPACE

@@ -11,7 +11,7 @@ slf4j_version = "1.7.7"
 distributedlog_version = "0.5.0"
 http_client_version = "4.5.2"
 
-# heron api server
+# heron API server
 jetty_version = "9.4.6.v20170531"
 jersey_verion = "2.25.1"
 hk2_api = "2.5.0-b32"
@@ -566,7 +566,7 @@ maven_jar(
 
 # end Kubernetes java client
 
-# heron api server
+# heron API server
 # jetty
 maven_jar(
   name = "org_eclipse_jetty_server",
@@ -723,7 +723,7 @@ maven_jar(
 )
 # end bookkeeper & distributedlog dependencies
 
-# end heron api server
+# end heron API server
 
 # Nomad dependencies
 maven_jar(

deploy/kubernetes/general/README.md

@@ -40,21 +40,21 @@ $ kubectl create -f https://raw.githubusercontent.com/apache/incubator-heron/mas
 $ kubectl create -f https://raw.githubusercontent.com/apache/incubator-heron/master/deploy/kubernetes/general/tools.yaml
 ```
 
-4. Start heron apiserver:
+4. Start heron API server:
 ```shell
 $ kubectl create -f https://raw.githubusercontent.com/apache/incubator-heron/master/deploy/kubernetes/general/apiserver.yaml
 ```
 
-### Deploy via heron apiserver
-We will start a proxy to the cluster and then construct a [proxy url](https://kubernetes.io/docs/tasks/administer-cluster/access-cluster-services/#manually-constructing-apiserver-proxy-urls) to access the apiserver.
+### Deploy via heron API server
+We will start a proxy to the cluster and then construct a [proxy url](https://kubernetes.io/docs/tasks/administer-cluster/access-cluster-services/#manually-constructing-apiserver-proxy-urls) to access the API server.
 
 
 1. Start kubectl proxy:
 ```shell
 $ kubectl proxy -p 8001
 ```
 
-2. Verify we can access the apiserver:
+2. Verify we can access the API server:
 
 ```shell
 $ curl http://localhost:8001/api/v1/proxy/namespaces/default/services/heron-apiserver:9000/api/v1/version

deploy/kubernetes/gke/gcs-apiserver.yaml

@@ -116,7 +116,7 @@ spec:
 ---
 
 ##
-## Service to expose the heron api server
+## Service to expose the heron API server
 ##
 apiVersion: v1
 kind: Service

deploy/kubernetes/gke/medium.yaml

@@ -30,7 +30,7 @@ platform: gke
 # Number of replicas for the job binary in bookkeeper
 jobReplicas: 2
 
-# amount of memory to provide for api server
+# amount of memory to provide for API server
 apiServerMemory: 512M
 
 # Number of replicas for storage bookies, memory and storage requirements 

deploy/kubernetes/gke/small.yaml

@@ -30,7 +30,7 @@ platform: gke
 # Number of replicas for the job binary in bookkeeper
 jobReplicas: 2
 
-# amount of memory to provide for api server
+# amount of memory to provide for API server
 apiServerMemory: 512M
 
 # Number of replicas for storage bookies, memory and storage requirements 

deploy/kubernetes/helm/templates/NOTES.txt

@@ -3,7 +3,7 @@ You can check the status of Heron by doing the following:
 1. Start kubectl proxy
    kubectl proxy -p 8001
 
-2. Verify you can access the api server
+2. Verify you can access the API server
    curl http://localhost:8001/api/v1/proxy/namespaces/{{ .Release.Namespace }}/services/{{ .Release.Name }}-apiserver:9000/api/v1/version
 
 3. Verify you can access the heron ui

deploy/kubernetes/helm/values.yaml.template

@@ -19,7 +19,7 @@ imagePullPolicy: IfNotPresent
 # Number of replicas for the job binary in bookkeeper
 jobReplicas: 1
 
-# amount of memory to provide for api server
+# amount of memory to provide for API server
 apiServerMemory: 512M
 
 # Number of replicas for storage bookies, memory and storage requirements

deploy/kubernetes/minikube/README.md

@@ -39,21 +39,21 @@ $ kubectl create -f https://raw.githubusercontent.com/apache/incubator-heron/mas
 $ kubectl create -f https://raw.githubusercontent.com/apache/incubator-heron/master/deploy/kubernetes/minikube/tools.yaml
 ```
 
-4. Start heron apiserver:
+4. Start heron API server:
 ```shell
 $ kubectl create -f https://raw.githubusercontent.com/apache/incubator-heron/master/deploy/kubernetes/minikube/apiserver.yaml
 ```
 
-### Deploy via heron apiserver
-We will start a proxy to the cluster and then construct a [proxy url](https://kubernetes.io/docs/tasks/administer-cluster/access-cluster-services/#manually-constructing-apiserver-proxy-urls) to access the apiserver.
+### Deploy via heron API server
+We will start a proxy to the cluster and then construct a [proxy url](https://kubernetes.io/docs/tasks/administer-cluster/access-cluster-services/#manually-constructing-apiserver-proxy-urls) to access the API server.
 
 
 1. Start kubectl proxy:
 ```shell
 $ kubectl proxy -p 8001
 ```
 
-2. Verify we can access the apiserver:
+2. Verify we can access the API server:
 
 ```shell
 $ curl http://localhost:8001/api/v1/proxy/namespaces/default/services/heron-apiserver:9000/api/v1/version

eco-heron-examples/src/java/org/apache/heron/examples/eco/heron_wordcount.yaml

@@ -30,12 +30,12 @@ config:
   topology.component.resourcemap:
 
     - id: "spout-1"
-      ram: 256MB # The minimum value for a component's specified ram is 256MB
+      ram: 256MB # The minimum value for a component's specified RAM is 256MB
       cpu: 0.5
       disk: 4GB
 
     - id: "bolt-1"
-      ram: 256MB # The minimum value for a component's specified ram is 256MB
+      ram: 256MB # The minimum value for a component's specified RAM is 256MB
       cpu: 0.5
       disk: 2GB
 

eco-storm-examples/src/java/org/apache/heron/examples/eco/simple_wordcount.yaml

@@ -29,12 +29,12 @@ config:
   topology.component.resourcemap:
 
     - id: "spout-1"
-      ram: 256MB # The minimum value for a component's specified ram is 256MB
+      ram: 256MB # The minimum value for a component's specified RAM is 256MB
       cpu: 0.5
       disk: 4GB
 
     - id: "bolt-1"
-      ram: 256MB # The minimum value for a component's specified ram is 256MB
+      ram: 256MB # The minimum value for a component's specified RAM is 256MB
       cpu: 0.5
       disk: 2GB
 

eco/src/java/org/apache/heron/eco/builder/ConfigBuilder.java

@@ -145,7 +145,7 @@ private void setComponentLevelResource(Config config, Map.Entry<String, Object>
         long megaBytes = extractRawValue(ramWithUom, mbIndex);
         if (megaBytes < MINIMUM_MB) {
           throw new IllegalArgumentException(
-              "The minimum Ram resource allocation for a component must be at least 256MB");
+              "The minimum RAM resource allocation for a component must be at least 256MB");
         }
         byteAmount = ByteAmount.fromMegabytes(megaBytes);
 
@@ -161,15 +161,15 @@ private void setComponentLevelResource(Config config, Map.Entry<String, Object>
         long bytes = extractRawValue(ramWithUom, bIndex);
         if (bytes < MINIMUM_BYTES) {
           throw new IllegalArgumentException(
-              "The minimum Ram resource allocation for a component must be at least 256000000B");
+              "The minimum RAM resource allocation for a component must be at least 256000000B");
         }
         byteAmount = ByteAmount.fromBytes(bytes);
 
       } else {
         // There is no format throw an exception
         throw new
             IllegalArgumentException(
-            " Please specify 'B', 'MB', 'GB' when declaring Ram Resources");
+            " Please specify 'B', 'MB', 'GB' when declaring RAM Resources");
       }
       config.setComponentRam(id, byteAmount);
     }

examples/src/java/org/apache/heron/examples/api/ComponentJVMOptionsTopology.java

@@ -78,7 +78,7 @@ public static void main(String[] args) throws Exception {
     conf.setContainerRamRequested(ByteAmount.fromGigabytes(2));
     conf.setContainerCpuRequested(2);
 
-    // Specify the size of ram padding to per container.
+    // Specify the size of RAM padding to per container.
     // Notice, this config will be considered as a hint,
     // and it's up to the packing algorithm to determine whether to apply this hint
     conf.setContainerRamPadding(ByteAmount.fromGigabytes(2));

examples/src/java/org/apache/heron/examples/api/spout/TestWordSpout.java

@@ -65,7 +65,7 @@ public void nextTuple() {
     final String word = words[rand.nextInt(words.length)];
     collector.emit(new Values(word));
     if (!throttleDuration.isZero()) {
-      SysUtils.sleep(throttleDuration); // sleep to throttle back cpu usage
+      SysUtils.sleep(throttleDuration); // sleep to throttle back CPU usage
     }
   }
 

heron/api/src/cpp/config/config.h

@@ -131,12 +131,12 @@ class Config {
   static const std::string TOPOLOGY_RELIABILITY_MODE;
 
   /**
-   * Number of cpu cores per container to be reserved for this topology
+   * Number of CPU cores per container to be reserved for this topology
    */
   static const std::string TOPOLOGY_CONTAINER_CPU_REQUESTED;
 
   /**
-   * Amount of ram per container to be reserved for this topology.
+   * Amount of RAM per container to be reserved for this topology.
    * In bytes.
    */
   static const std::string TOPOLOGY_CONTAINER_RAM_REQUESTED;
@@ -148,12 +148,12 @@ class Config {
   static const std::string TOPOLOGY_CONTAINER_DISK_REQUESTED;
 
   /**
-   * Hint for max number of cpu cores per container to be reserved for this topology
+   * Hint for max number of CPU cores per container to be reserved for this topology
    */
   static const std::string TOPOLOGY_CONTAINER_MAX_CPU_HINT;
 
   /**
-   * Hint for max amount of ram per container to be reserved for this topology.
+   * Hint for max amount of RAM per container to be reserved for this topology.
    * In bytes.
    */
   static const std::string TOPOLOGY_CONTAINER_MAX_RAM_HINT;
@@ -171,19 +171,19 @@ class Config {
   static const std::string TOPOLOGY_CONTAINER_PADDING_PERCENTAGE;
 
   /**
-   * Amount of ram to pad each container for this topology.
+   * Amount of RAM to pad each container for this topology.
    * In bytes.
    */
   static const std::string TOPOLOGY_CONTAINER_RAM_PADDING;
 
   /**
-   * Per component cpu requirement.  The format of this flag is something like
+   * Per component CPU requirement.  The format of this flag is something like
    * spout0:0.2,spout1:0.2,bolt1:0.5.
    */
   static const std::string TOPOLOGY_COMPONENT_CPUMAP;
 
   /**
-   * Per component ram requirement.  The format of this flag is something like
+   * Per component RAM requirement.  The format of this flag is something like
    * spout0:12434,spout1:345353,bolt1:545356.
    */
   static const std::string TOPOLOGY_COMPONENT_RAMMAP;
@@ -305,14 +305,14 @@ class Config {
 
   void setComponentCpu(const std::string& componentName, double cpu) {
     if (cpu < 0) {
-      throw std::runtime_error("Invalid Cpu specified for component");
+      throw std::runtime_error("Invalid CPU specified for component");
     }
     appendComponentConfig<double>(Config::TOPOLOGY_COMPONENT_CPUMAP, componentName, cpu);
   }
 
   void setComponentRam(const std::string& componentName, int64_t bytes) {
     if (bytes < 0) {
-      throw std::runtime_error("Invalid Ram specified for component");
+      throw std::runtime_error("Invalid RAM specified for component");
     }
     appendComponentConfig<int64_t>(Config::TOPOLOGY_COMPONENT_RAMMAP, componentName, bytes);
   }

heron/api/src/java/org/apache/heron/api/Config.java

@@ -48,7 +48,7 @@ public class Config extends HashMap<String, Object> {
    */
   public static final String TOPOLOGY_WORKER_CHILDOPTS = "topology.worker.childopts";
   /**
-   * Per component jvm options.  The format of this flag is something like
+   * Per component JVM options.  The format of this flag is something like
    * spout0:jvmopt_for_spout0,spout1:jvmopt_for_spout1. Mostly should be used
    * in conjunction with setComponentJvmOptions(). This is used in addition
    * to TOPOLOGY_WORKER_CHILDOPTS. While TOPOLOGY_WORKER_CHILDOPTS applies for
@@ -153,11 +153,11 @@ public enum TopologyReliabilityMode {
   public static final String TOPOLOGY_RELIABILITY_MODE = "topology.reliability.mode";
 
   /**
-   * Number of cpu cores per container to be reserved for this topology
+   * Number of CPU cores per container to be reserved for this topology
    */
   public static final String TOPOLOGY_CONTAINER_CPU_REQUESTED = "topology.container.cpu";
   /**
-   * Amount of ram per container to be reserved for this topology.
+   * Amount of RAM per container to be reserved for this topology.
    * In bytes.
    */
   public static final String TOPOLOGY_CONTAINER_RAM_REQUESTED = "topology.container.ram";
@@ -167,11 +167,11 @@ public enum TopologyReliabilityMode {
    */
   public static final String TOPOLOGY_CONTAINER_DISK_REQUESTED = "topology.container.disk";
   /**
-   * Hint for max number of cpu cores per container to be reserved for this topology
+   * Hint for max number of CPU cores per container to be reserved for this topology
    */
   public static final String TOPOLOGY_CONTAINER_MAX_CPU_HINT = "topology.container.max.cpu.hint";
   /**
-   * Hint for max amount of ram per container to be reserved for this topology.
+   * Hint for max amount of RAM per container to be reserved for this topology.
    * In bytes.
    */
   public static final String TOPOLOGY_CONTAINER_MAX_RAM_HINT = "topology.container.max.ram.hint";
@@ -187,22 +187,22 @@ public enum TopologyReliabilityMode {
   public static final String TOPOLOGY_CONTAINER_PADDING_PERCENTAGE
       = "topology.container.padding.percentage";
   /**
-   * Amount of ram to pad each container.
+   * Amount of RAM to pad each container.
    * In bytes.
    */
   public static final String TOPOLOGY_CONTAINER_RAM_PADDING = "topology.container.ram.padding";
   /**
-   * Per component ram requirement.  The format of this flag is something like
+   * Per component RAM requirement.  The format of this flag is something like
    * spout0:0.2,spout1:0.2,bolt1:0.5.
    */
   public static final String TOPOLOGY_COMPONENT_CPUMAP = "topology.component.cpumap";
   /**
-   * Per component ram requirement.  The format of this flag is something like
+   * Per component RAM requirement.  The format of this flag is something like
    * spout0:12434,spout1:345353,bolt1:545356.
    */
   public static final String TOPOLOGY_COMPONENT_RAMMAP = "topology.component.rammap";
   /**
-   * Per component ram requirement.  The format of this flag is something like
+   * Per component RAM requirement.  The format of this flag is something like
    * spout0:12434,spout1:345353,bolt1:545356.
    */
   public static final String TOPOLOGY_COMPONENT_DISKMAP = "topology.component.diskmap";

heron/api/src/java/org/apache/heron/api/utils/TopologyUtils.java

@@ -181,7 +181,7 @@ public static boolean verifyTopology(TopologyAPI.Topology topology) {
       return false;
     }
 
-    // Only verify ram map string well-formed.
+    // Only verify RAM map string well-formed.
     getComponentRamMapConfig(topology);
     // Verify all bolts input streams exist. First get all output streams.
     Set<String> outputStreams = new HashSet<>();
@@ -244,7 +244,7 @@ public static Map<String, Double> getComponentCpuMapConfig(TopologyAPI.Topology
    * Returns a empty map if the Config is not set
    *
    * @param topology the topology def
-   * @return a map (componentName -&gt; ram required)
+   * @return a map (componentName -&gt; RAM required)
    */
   public static Map<String, ByteAmount> getComponentRamMapConfig(TopologyAPI.Topology topology)
       throws RuntimeException {

heron/api/src/java/org/apache/heron/streamlet/Builder.java

@@ -24,7 +24,7 @@
 
 /**
  * Builder is used to register all sources. Builder thus keeps track
- * of all the starting points of the computation dag and uses this
+ * of all the starting points of the computation DAG and uses this
  * information to build the topology
  */
 public interface Builder {

heron/api/src/java/org/apache/heron/streamlet/impl/BuilderImpl.java

@@ -33,7 +33,7 @@
 /**
  * BuilderImpl implements the Builder interface.
  * The builder keeps track of the all the sources of the
- * computation dag and builds the Topology by traversing all
+ * computation DAG and builds the Topology by traversing all
  * the computation nodes.
  */
 public final class BuilderImpl implements Builder {

heron/api/src/scala/org/apache/heron/streamlet/scala/Builder.scala

@@ -22,7 +22,7 @@ import org.apache.heron.streamlet.scala.impl.BuilderImpl
 
 /**
   * Builder is used to register all sources. Builder thus keeps track
-  * of all the starting points of the computation dag and uses this
+  * of all the starting points of the computation DAG and uses this
   * information to build the topology
   */
 object Builder {
@@ -32,7 +32,7 @@ object Builder {
 
 /**
   * Builder is used to register all sources. Builder thus keeps track
-  * of all the starting points of the computation dag and uses this
+  * of all the starting points of the computation DAG and uses this
   * information to build the topology
   */
 trait Builder {