Revision d3d35ae0

b/docs/examples.rst
12 12
    examplesdir/imageregister
13 13
    examplesdir/server
14 14
    examplesdir/network
15
    examplesdir/astakos
b/docs/examplesdir/astakos.rst
1
Astakos
2
=======
3

  
4
`Astakos <http://www.synnefo.org/docs/synnefo/latest/astakos-api-guide.html>`_
5
is the synnefo implementation of a variant of OpenStack Keystone with custom
6
extentions. Kamaki offer tools for managing Astakos information.
7

  
8
.. node:: The underlying library that calls the API is part of the synnefo
9
    and it is called 'astakosclient'
10

  
11
User
12
----
13

  
14
.. code-block:: console
15

  
16
    $ kamaki user authenticate
17
    ...
18
    endpoints:
19
            SNF:uiURL: https://example.com/ui/
20
            versionId: 
21
            region: default
22
            publicURL: https://example.com/admin
23
        endpoints_links:
24
        type: admin
25
        name: cyclades_admin
26
    user:
27
        roles_links:
28
        id: some-u53r-1d
29
        roles:
30
            id: 1
31
            name: default
32
        name: Example User
33

  
34
    $ kamaki user add z01db3rgs-u53r-t0k3n
35
    ...
36
    endpoints:
37
            SNF:uiURL: https://example.com/ui/
38
            versionId: 
39
            region: default
40
            publicURL: https://example.com/admin
41
        endpoints_links:
42
        type: admin
43
        name: cyclades_admin
44
    user:
45
        roles_links:
46
        id: z01db3rgs-u53r-1d
47
        roles:
48
            id: 1
49
            name: default
50
        name: Dr. Harold Zoidberg
51

  
52
    $ kamaki user info
53
    roles_links:
54
    id: s0m3-u53r-1d
55
    roles:
56
        id: 1
57
        name: default
58
    name: Example User
59

  
60
    $ kamaki user info --uuid=z01db3rgs-u53r-1d
61
    roles_links:
62
    id: z01db3rgs-u53r-1d
63
    roles:
64
        id: 1
65
        name: default
66
    name: EDr. Harold Zoidberg
67

  
68
    $ kamaki user select z01db3rgs-u53r-1d
69
    Are you sure? [y/N]: y
70

  
71
    $ kamaki user uuid2name z01db3rgs-u53r-1d s0m3-u53r-1d
72
    z01db3rgs-u53r-1d: zoidberg@planetexpress.com
73
    s0m3-u53r-1d: someuser@example.com
74

  
75
Quotas and resources
76
--------------------
77

  
78
.. code-block:: console
79

  
80
    $ kamaki quota list
81
    system:
82
        cyclades.disk:
83
            usage: 0B
84
            limit: 100GiB
85
            pending: 0B
86
        cyclades.vm:
87
            usage: 0
88
            limit: 2
89
            pending: 0
90
        pithos.diskspace:
91
            usage: 5.11GiB
92
            limit: 50GiB
93
            pending: 0B
94
        cyclades.ram:
95
            usage: 0B
96
            limit: 8GiB
97
            pending: 0B
98
        cyclades.cpu:
99
            usage: 0
100
            limit: 8
101
            pending: 0
102
        cyclades.network.private:
103
            usage: 0
104
            limit: 5
105
            pending: 0
106

  
107
    $ kamaki resource list
108
    cyclades.disk:
109
        service: cyclades_compute
110
        description: Virtual machine disk size
111
        unit: bytes
112
        allow_in_projects: True
113
    cyclades.vm:
114
        service: cyclades_compute
115
        description: Number of virtual machines
116
        unit: None
117
        allow_in_projects: True
118
    pithos.diskspace:
119
        service: pithos_object-store
120
        description: Pithos account diskspace
121
        unit: bytes
122
        allow_in_projects: True
123
    cyclades.ram:
124
        service: cyclades_compute
125
        description: Virtual machine memory size
126
        unit: bytes
127
        allow_in_projects: True
128
    cyclades.cpu:
129
        service: cyclades_compute
130
        description: Number of virtual machine processors
131
        unit: None
132
        allow_in_projects: True
133
    cyclades.network.private:
134
        service: cyclades_compute
135
        description: Number of private networks
136
        unit: None
137
        allow_in_projects: True
138

  
139
Projects
140
--------
141

  
142
.. code-block:: console
143

  
144
    $ kamaki project list
145
    1 newtitle.film.example.com
146
        end_date: 2014-03-31T00:00:00+00:00
147
        description: Our new film project
148
        join_policy: auto
149
        max_members: None
150
        applicant: s0m3-4pp1ic4n7
151
        leave_policy: auto
152
        creation_date: 2013-01-31T09:36:04.061130+00:00
153
        application: 4
154
        state: active
155
        start_date: 2013-01-31T00:00:00+00:00
156
        owner: s0m3-4pp1ic4n7
157
        homepage: http://example.com/film
158
        resources:
159
    29 many.quotas
160
        end_date: 2013-12-12T00:00:00+00:00
161
        description: I need more quotas
162
        join_policy: moderated
163
        max_members: 10
164
        applicant: s0m3-u53r-1d
165
        leave_policy: auto
166
        creation_date: 2013-02-14T09:26:23.034177+00:00
167
        application: 108
168
        state: active
169
        start_date: 2013-02-14T00:00:00+00:00
170
        owner: s0m3-u53r-1d
171
        homepage: http://example.com
172
        resources:
173
            cyclades.disk:
174
                member_capacity: 109951162777600
175
                project_capacity: None
176
            cyclades.vm:
177
                member_capacity: 1000
178
                project_capacity: None
179
            cyclades.cpu:
180
                member_capacity: 2000
181
                project_capacity: None
182
            cyclades.ram:
183
                member_capacity: 4398046511104
184
                project_capacity: None
185
            pithos.diskspace:
186
                member_capacity: 107374182400
187
                project_capacity: None
188
            cyclades.floating_ip:
189
                member_capacity: 1000
190
                project_capacity: None
191

  

Also available in: Unified diff