[Swiftstack] Revise Plugin Guide to make concepts clear and eliminate wording issues

Bug #1593206 reported by Irina Povolotskaya
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Fuel Plugins
Fix Released
High
Trey Duskin

Bug Description

Current Plugin Guide version features unclear concepts, no LP bugs references and working problems:

1. Please use DNS server insteand of static hostname records in /etc/hosts. -> typo, must be ‘instead’
2. In SwiftStack Swift cluster, that have three network interfaces need to configure for each node. > in clusters that have OR in cluster that has ..?
3. The clients traffic comeS into this interface
4. The interface for Swift internal traffic likes proxy-server from/to object-server. -> ? what stands for ‘likes’ ?connects? points?
5. If the node only has one network interface, you can assign all network interfaces to this interface, but it’ll be mixed all traffic together. -> you mean, if the node has only one physical network interface, you can map all logical networks to this interface, but then there might be a bottleneck.
6. So we suggest using dedicated interface for these three network. -> networkS
7. SwiftStack provide two types of controllers -> provideS
8. The public controller is for customers they don’t want to setup a SwiftStack Controller on their data center and also allow the nodes have internet connectivity for management purpose. -> Customers can pick public controllers if they don’t want to set up a Swiftstack Controller in their data center; what’s more, this approach allows all the Swiftstack nodes to have internet connectivity….
9. In On-Premises controller, you need to get the setup script and tarball from SwiftStack sales, and they’ll help you to setup an On-Premises controller. -> If you’d like to use On-Premises Controller, you need to contact Swiftstack Sales team <URL pointing to the email address> to get the setup script and the tarball. They’ll also assist with installation procedure.
10. And make sure you have an account can login to controller and able to setup a Swift cluster before you start to test the plugin. -> I don’t get this phrase and logic.
11. The network configuration in SwiftStack Controller is quite simple, just check the SwiftStack Nodes can reach Swift- Stack controller because SwiftStack Nodes communciate with controller over OpenVPN connections. -> … just check if the Swiftstack nodes can reach Swiftstack Controller (Swiftstack Nodes communicate with Controller over OpenVPN connections <URL to Swiftstack docs on VPN peculiarities>).
12. but if you have a firewall in the middle; please check SwiftStack Controller Security and SwiftStack Node Security to configure the firewall. -> If you plan to have the firewall between Swiftstack ndoes and Controller, please be sure to review the guidelines on configuring the firewall <URL>
13. The Swift cluster is outside of Fuel environment, so using the Controller to create and configure your external Swift cluster which will be more efficienct from scratch. -> ..I don’t get this.
14. so if SwiftStack Nodes are connected to these three networks and use same IP range of Fuel’s configuration, you need to skip the IPs that used for SwiftStack Nodes. -> that are used for …
15. So connected to the Fuel slave nodes with Outward-facing network that’s for clients. -> I don’t get this phrase.
16. Then Fuel Managment network will use for doing user token validation between the Swift cluster and Keystone server. -> Management will be used for running user token validation
17. We only use one PACO (Proxy/Account/Comtainer/Object) nodes to deploy a all-in-one Swift cluster in this document and is a minimum deployment. -> the all-in-one in this document and such a configuration can be used for evaluation purposes only.
18. In real environment, as the cluster scales, it might be necessary to specalize nodes into separate Proxy/Account/Container/Object tiers. -> In production environment, as the cluster scaler, …. to assign nodes …
19. so please make sure the On-Premises controller also connected to Fuel Management network. ->… On-Premises Controller is also connected …
20. so please make sure SwiftStack Nodes able to reach Internet. -> are able to reach
21. 1. Go to the Settings tab of the Fuel Web UI, scroll down to Storage section, select Enable SwiftStack Swift Cluster Integration checkbox and fill up all parameters. -> issue with steps numbering.
22. This option will use HTTPS for Swift endpoints include public, admin and internal urls ->include-> including
23. That means some Functional tests won’t pass: Create volume and boot instance from it. -> here, you mean that OSTF won’t pass?
24. Go to the Network tab > … of the Swiftstack UI
25. Outtward-facing IP from SwiftStack Controller UI -> outward
26. Please login to the Fuel master -> the Fuel Master node
27. the output on page 11 ( the one on script) is too long.

Changed in fuel-plugins:
importance: Undecided → High
Trey Duskin (treyd)
Changed in fuel-plugins:
status: New → In Progress
assignee: Charles Hsu (charles0126) → Trey Duskin (treyd)
Revision history for this message
Trey Duskin (treyd) wrote :

Please Review https://review.openstack.org/#/c/330772/

for #23, Charles can you please explain what functional test you mean here?

for #24, I'm not able to find this line... there is a line about the Networks tab of the Fuel UI, which is correct.

for #27, how do you suggest we fix this? Remove the output all together?

Revision history for this message
Charles Hsu (charles0126) wrote :

for #23, yes, that causes some OSTF can't pass.

Revision history for this message
Trey Duskin (treyd) wrote :

updated documentation to clarify item #23: https://review.openstack.org/#/c/330772/

Changed in fuel-plugins:
status: In Progress → Fix Committed
Changed in fuel-plugins:
status: Fix Committed → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on fuel-plugin-swiftstack (master)

Change abandoned by Clark Boylan (<email address hidden>) on branch: master
Review: https://review.opendev.org/330772
Reason: Fuel projects have been retired.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.