quickstart/index.html at master · vaultdbai/quickstart · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<html>
  <head>
    <meta charset="UTF-8" />
    <meta content="width=device-width, initial-scale=1" name="viewport" />
    <meta name="x-apple-disable-message-reformatting" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta content="telephone=no" name="format-detection" />
    <title>VaultDB: Deploy</title>
  </head>
  <body>
    <h1>VaultDB IOT Database platform</h1>
    <p>
      This repository contains the VaultDB ai platform aws quickstart templates.
    </p>
    <h2>Architecture Diagram</h2>
    <p>
      <h4>Componets created by the Cloudformation Templates</h4>
      <img src="content/architecture.png" style="width: 366.75px; height: 269.25px" />
    </p>
    <h2>Cost</h2>
    <h4>You Pay to AWS for the amount of Data storage and Lambda Compute you use. typical cost for my development and testing is close to <b>Zero</b></h4>
    <h2>Setup Environment</h2>
    <h3>Create Service Role</h3>
    <p>
      <a
        target="vaultdb_cloudformation"
        href="https://console.aws.amazon.com/cloudformation/home?#/stacks/new?stackName=vaultdb-service-role&templateURL=https://vaultdb-web.s3.us-east-2.amazonaws.com/awsquickstart/service-role.yaml"
      >
        <img
          alt="launch stack button"
          src=" https://s3.amazonaws.com/cloudformation-examples/cloudformation-launch-stack.png"
          style="width: 144px; height: 27px"
        />
      </a>
    </p>
    <h4>AWS CLI Command to Create Service Role</h4>
    <pre><code>awsv2 cloudformation create-stack --stack-name vaultdb-service-role --template-body https://vaultdb-web.s3.us-east-2.amazonaws.com/awsquickstart/service-role.yaml --capabilities CAPABILITY_NAMED_IAM
    </code></pre>
    <h4>Create VaultDB Instance using Service Role created above</h4>
    <p>
      <a
        target="vaultdb_cloudformation"
        href="https://console.aws.amazon.com/cloudformation/home?#/stacks/new?stackName=vaultdb-database&templateURL=https://vaultdb-web.s3.us-east-2.amazonaws.com/awsquickstart/vaultdb.yaml"
      >
        <img
          alt="launch stack button"
          src=" https://s3.amazonaws.com/cloudformation-examples/cloudformation-launch-stack.png"
          style="width: 144px; height: 27px"
        />
      </a>
    </p>
    <h4>AWS CLI Command to Create VaultDB Instance</h4>
    <pre><code>awsv2 cloudformation create-stack --stack-name [APPLICATION-STACK-NAME] --role-arn &quot;arn:aws:iam::[AWS-ACCOUNT-NUMBER]:role/vaultdb_cloudformation_service_role&quot; --template-url https://vaultdb-web.s3.us-east-2.amazonaws.com/awsquickstart/vaultdb.yaml --parameters ParameterKey=&quot;AdminEmail&quot;,ParameterValue=&quot;[APPLICATION-ADMIN-EMAIL-ADDRESS]&quot; ParameterKey=&quot;PrimarySubnetAZ&quot;,ParameterValue=&quot;[AWS-REGION]&quot; ParameterKey=&quot;ExistingVpcID&quot;,ParameterValue=&quot;[VPC-ID]&quot; ParameterKey=&quot;PrivateSubnetCIDR&quot;,ParameterValue=&quot;[PRIVATE-SUBNET-CIDR]&quot; ParameterKey=&quot;BucketName&quot;,ParameterValue=&quot;vaultdb-web&quot; --capabilities CAPABILITY_NAMED_IAM CAPABILITY_AUTO_EXPAND

    Values you can use:--
        APPLICATION-STACK-NAME
            Pick a Uniquename for your installation and append test/dev/uat/prod etc to diffrentiate between different environments.
        AWS-ACCOUNT-NUMBER
            AWS Account number
        APPLICATION-ADMIN-EMAIL-ADDRESS
            this email will receive the user passwords and instructions on how to start using VAULTDB ai platform.
        AWS-REGION
            please enter the region in which you would like to deploy VaultDB at. eg. us-east-1a
        VPC-ID
            Provide the VPC ID if you have one and wants to use that otherwise remove the parameter all together or provide empty value
        PRIVATE-SUBNET-CIDR
            172.31.200.0/20
    </code></pre>
    <h6>Delete/ Uninstall</h6>
    <p>
      awsv2 cloudformation delete-stack --stack-name [APPLICATION-STACK-NAME]
    </p>
    <h2>License</h2>
    <p>All Images and Text copyright VaultDB.ai LLC</p>
  </body>
</html>