diff --git a/plugins/integrations/cloudian/docs/.gitignore b/plugins/integrations/cloudian/docs/.gitignore new file mode 100644 index 00000000000..2d19fc766d9 --- /dev/null +++ b/plugins/integrations/cloudian/docs/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/plugins/integrations/cloudian/docs/Makefile b/plugins/integrations/cloudian/docs/Makefile new file mode 100644 index 00000000000..f1f68b1a214 --- /dev/null +++ b/plugins/integrations/cloudian/docs/Makefile @@ -0,0 +1,25 @@ +# Use VERSION and RELEASE_CANDIDATE from the parent Makefile +# but if we do a local make docs in this directory just use +# these. The main Makefile ones are the ones to keep updated. +CPVER ?= 4.9 +HSVER ?= 6.2 +RC ?= 1 + +HTML = $(patsubst %.txt,%.html,$(shell find . -name \*.txt)) + +.PHONY: all clean + +all: $(HTML) + +clean: + rm -f $(HTML) + +%.html: %.txt +ifneq ("$(wildcard /etc/fedora-release)","") + # Only check spelling on fedora and only if have tty + -tty -s && aspell --dont-backup -p ./aspell.dict -c $( 'Secondary Storage'. +|3|Click 'Select View' and select 'Secondary Staging Store'. +|4|Click 'Add Secondary Staging Store'. +|5|Configure the 'zone', 'server' and 'path' for your desired +secondary staging store. For example 'nfs.mycloud.com' and +'/export/staging'. +| a|image::images/s3_ss_cache.png[height="300", "S3 Secondary Staging Store Configuration Example"] +|====================== + + +=== Attach Cloudian as Secondary Storage +CloudStack supports using either S3 or NFS as Secondary Storage but +not both. The below instructions assume you are not using Secondary +Storage on NFS and that you can delete it to add the S3 storage. + +WARNING: *Already using NFS for Secondary Storage with CloudStack?* +You need to migrate your Secondary Storage. Refer to CloudStack's +instructions for 'migrating' existing NFS Secondary Storage to an +S3 object storage. CloudStack 4.5 onwards supports migrating data via +special commands which are described in the 'Getting Started Guide' in a +section titled 'Upgrading from NFS to Object Storage'. + +.D. [CloudStack admin user] Adding S3 Secondary Storage +[options="header",cols="1,10"] +[frame="topbot",grid="none"] +|====================== +|Step|Description +|1|Login to CloudStack Management Server as the 'admin' user. +|2|Navigate to 'Infrastructure' -> 'Secondary Storage'. +|3|If it exists, select and delete any existing NFS Secondary Storage +server setting. [yellow-background]*NOTE: Do not do this if you +want to migrate existing NFS secondary storage to S3. Instead, see +warning above.* +|4|Click the 'Add Secondary Storage' button. This will open up a pop-up +form which you can fill out similarly to below. +| a|image::images/s3_ss_config.png["S3 Secondary Storage Configuration Example"] +|====================== + +.Secondary Storage Pop-up Example Configuration +[options="header",cols="2,3,8",width="100%"] +|====================== +|Field|Value|Description +|Name|Cloudian|Any name which identifies this S3 storage for you is ok. +|Provider|S3|The S3 provider is used to configure generic S3 storage. +|Access Key||The access key of the Cloudian account that +owns the S3 bucket. Use the one for the 'cloudplatform' user in +<> above. +|Secret Key||The secret key of the Cloudian account that +owns the S3 bucket. Use the one for the 'cloudplatform' user in +<> above. +|Bucket|secondary|The name of the S3 bucket that you created for the +'cloudplatform' user in <> above. +|Endpoint|s3-tokyo.mycloud.com|This is the S3 endpoint. If your S3 server +is not running on a standard port such as port 80 or port 443 for HTTPS, +you must add a port here also. Example: 's3-tokyo.mycloud.com:18443'. +|Use HTTPS||Check 'Use HTTPS' only if you have configured your +S3 service with a *trusted SSL certificate* and enabled HTTPS. Your HTTPS +service should be listening on port 443 or you provided a port in the +endpoint configuration above. Otherwise, uncheck this option. +|Connection Timeout||Leave this option blank. +|Max Error Retry||Leave this option blank. +|Socket Timeout||Leave this option blank. +|Create NFS Secondary Staging Store||You should be able to leave +this option unchecked as a NFS Secondary Staging Store was explicitly +configured in the previous step. +|NFS Server||The staging server is already configured. +|Path||The staging server is already configured. +|====================== + +CAUTION: CloudStack doesn't currently allow you to re-edit the S3 +configuration so take time to double check what you enter. If you +make a mistake the only options currently are either a) delete and recreate +the storage or b) directly edit the entry in the database. + +=== All Done! +When you have finished adding Cloudian as Secondary Storage in the previous steps, +CloudStack will populate the new secondary storage with the system +and default templates. This can take some time do download as the templates +are quite big. + +[TIP] +==== +You can check if the system template and the default template have properly +downloaded to the new secondary storage by navigating to 'Templates', +selecting a template, clicking on the 'Zones' tab and checking its Status is +Ready 100% Downloaded. + +Should you continue to have problems, sometimes it is necessary to restart +the Secondary Storage VM. You can do this by navigating to 'Infrastructure', +'System VMs', selecting and rebooting the 'Secondary Storage VM'. +==== + +CloudStack should now ready to use Cloudian HyperStore for S3 Secondary Storage. + +'''' + +_Confidentiality Notice_ + +_The information contained in this document is confidential to, and is the +intellectual property of, Cloudian, Inc. Neither this document nor any +information contained herein may be (1) used in any manner other than to +support the use of Cloudian software in accordance with a valid license +obtained from Cloudian, Inc, or (2) reproduced, disclosed or otherwise +provided to others under any circumstances, without the prior written +permission of Cloudian, Inc. Without limiting the foregoing, use of any +information contained in this document in connection with the development +of a product or service that may be competitive with Cloudian software +is strictly prohibited. Any permitted reproduction of this document or +any portion hereof must be accompanied by this legend._