| README.mdView |
|---|
| 1 … | +# Butt as a Service |
| 2 … | + |
| 3 … | +what if everyone had a friend in the cloud? |
| 4 … | + |
| 5 … | +Butt as a Service helps you provision and monitor Scuttlebutt bots in the cloud. |
| 6 … | + |
| 7 … | +## job stories |
| 8 … | + |
| 9 … | +- when i want to start a bot, |
| 10 … | + - if i haven't been here before: i can register, setup a monthly payment, and name my first bot |
| 11 … | + - if i have been here before: i can sign in |
| 12 … | +- when i come home, i can see a dashboard for my bots |
| 13 … | +- when i want to monitor a bot, i can see visual data about the pub service |
| 14 … | +- when i want to update the bot's status, i can stop or restart my bot |
| 15 … | +- when i want to update the bot's code, i can upgrade or rebuild from the bot's source |
| 16 … | +- when i want to export a bot, i can retrieve my secret, gossip, log, or blobs |
| 17 … | + |
| 18 … | +## design |
| 19 … | + |
| 20 … | +### landing |
| 21 … | + |
| 22 … | + ---------------- |
| 23 … | + = butt.nz |
| 24 … | + ---------------- |
| 25 … | + [start] |
| 26 … | + |
| 27 … | +--- |
| 28 … | + |
| 29 … | +### start |
| 30 … | + |
| 31 … | + ---------------- |
| 32 … | + v start x |
| 33 … | + ---------------- |
| 34 … | + - email |
| 35 … | + - password |
| 36 … | + |
| 37 … | + [yes] |
| 38 … | + |
| 39 … | +--- |
| 40 … | + |
| 41 … | +### newbie |
| 42 … | + |
| 43 … | + ---------------- |
| 44 … | + v newbie x |
| 45 … | + ---------------- |
| 46 … | + welcome! |
| 47 … | + |
| 48 … | + - name |
| 49 … | + - payment |
| 50 … | + - bot |
| 51 … | + - name |
| 52 … | + |
| 53 … | + [yes] |
| 54 … | + |
| 55 … | +--- |
| 56 … | + |
| 57 … | +### dashboad |
| 58 … | + |
| 59 … | + ---------------- |
| 60 … | + = butt.nz |
| 61 … | + ---------------- |
| 62 … | + - [my.butt.nz] #alive |
| 63 … | + - [your.butt.nz] #alive |
| 64 … | + |
| 65 … | +--- |
| 66 … | + |
| 67 … | +### bot: actions |
| 68 … | + |
| 69 … | + ---------------- |
| 70 … | + = your.butt.nz #alive |
| 71 … | + ---------------- |
| 72 … | + [**actions**] | [status] | [invites] |
| 73 … | + |
| 74 … | + - [invite] |
| 75 … | + - [restart] |
| 76 … | + - [stop] |
| 77 … | + - [upgrade] |
| 78 … | + - [rebuild] |
| 79 … | + - [export] |
| 80 … | + - [delete] |
| 81 … | + |
| 82 … | +--- |
| 83 … | + |
| 84 … | +### bot: status |
| 85 … | + |
| 86 … | + ---------------- |
| 87 … | + = your.butt.nz #alive |
| 88 … | + ---------------- |
| 89 … | + [actions] | [**status**] | [invites] |
| 90 … | + |
| 91 … | + status: alive |
| 92 … | + uptime: 100 days |
| 93 … | + disk usage: 10 GiB |
| 94 … | + bandwidth usage: 100GiB |
| 95 … | + memory usage: 100 MiB |
| 96 … | + |
| 97 … | +--- |
| 98 … | + |
| 99 … | +### bot: invites |
| 100 … | + |
| 101 … | + ---------------- |
| 102 … | + = your.butt.nz #alive |
| 103 … | + ---------------- |
| 104 … | + [actions] | [status | [**invites**] |
| 105 … | + |
| 106 … | + - used |
| 107 … | + - alice: ... |
| 108 … | + - bob: ... |
| 109 … | + - unused |
| 110 … | + - carol: ... |
| 111 … | + - dan: ... |
| 112 … | + - eve: ... |
| 113 … | + |
| 114 … | +--- |
| 115 … | + |
| 116 … | +## data |
| 117 … | + |
| 118 … | +### agent |
| 119 … | + |
| 120 … | +- type |
| 121 … | +- name |
| 122 … | +- description |
| 123 … | +- service |
| 124 … | + |
| 125 … | +### belongs |
| 126 … | + |
| 127 … | +- sourceAgentId |
| 128 … | +- targetAgentId |
| 129 … | + |
| 130 … | +## services |
| 131 … | + |
| 132 … | +- public http server |
| 133 … | + - /authentication/sign-in |
| 134 … | + - /authentication/register |
| 135 … | + - /agents |
| 136 … | +- private http server |
| 137 … | + - /agents |
| 138 … | +- each person agent has many bot agents |
| 139 … | +- for each person agent, run |
| 140 … | + - cloud compute |
| 141 … | + - cloud storage |
| 142 … | +- for each bot agent, run |
| 143 … | + - for each pub |
| 144 … | + - docker service |
| 145 … | + |
| 146 … | +### modules |
| 147 … | + |
| 148 … | +- public http server |
| 149 … | + - feathers |
| 150 … | + - feathers-authentication |
| 151 … | +- private http server |
| 152 … | + - feathers |
| 153 … | +- cloud provider: scaleway |
| 154 … | +- cloud orchestration: saltstack |
| 155 … | + - get config: salt.pillar.http_json.ext_pillar |