Skip to content

Commit

Permalink
cleanup MIT Licence and adjust help texts
Browse files Browse the repository at this point in the history
  • Loading branch information
hgw77 committed Nov 14, 2024
1 parent 4e3b56e commit 6ee0164
Show file tree
Hide file tree
Showing 41 changed files with 128 additions and 77 deletions.
19 changes: 9 additions & 10 deletions config/support/domain_config.yaml
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
# this config is used to control the visibility of plugins in the navigation,
# to define floating ip networks.
domains:
- name: test
regex: "__test__"
- name: iaas
regex: "^iaas-.*$"
disabled_plugins:
- automation
- reports
- masterdata_cockpit
- webconsole
disabled_features:
- documentation
- support
- domain_switcher
disabled_plugins:
# following plugins name should be the same as the plugin name in the plugins directory
- test-plugin
floating_ip_networks:
- "test_05"
- "test_04"
- "test_03"
- "test_02"
- "test_01"
- FloatingIP-external-iaas-01
dns_c_subdomain: false
check_cidr_range: false
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
= MasterdataCockpit

This project rocks and uses MIT-LICENSE.
3 changes: 0 additions & 3 deletions plugins/audit/README.rdoc

This file was deleted.

8 changes: 4 additions & 4 deletions plugins/audit/plugin_help.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#### What is Audit Log?

Audit Log provides an audit trail or change log for Converged Cloud services.
The Audit Log feature offers a comprehensive audit trail and change log for Converged Cloud services.

It records audit-relevant activities and stores them in a project-specific journal. In the journal, each recorded activity is represented by an audit event. The event describes the performed activity, the outcome and lastly the resources that are affected.
It captures audit-relevant activities and stores them in a project-specific journal. Within this journal, each recorded activity is represented by an audit event. These events detail the performed action, its outcome, and the affected resources.

This service is not just for auditors! Use it to conduct a root-cause analysis when you run into configuration issues (e.g. downtimes). With the information of the audit events, it is much easier to separate human error from platform malfunctions.
This service isn't exclusively for auditors. It's a valuable tool for conducting root-cause analysis when encountering configuration issues, such as downtimes. The information provided by audit events significantly simplifies the process of distinguishing between human errors and platform malfunctions.

For now only Keystone events are recorded, additional sources will be added one by one.
Currently, the system only records Keystone events. However, additional sources will be incorporated incrementally in the future.
20 changes: 20 additions & 0 deletions plugins/automation/MIT-LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright 2016 TODO: Write your name

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1 change: 1 addition & 0 deletions plugins/automation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This project rocks and uses MIT-LICENSE.
3 changes: 0 additions & 3 deletions plugins/automation/README.rdoc

This file was deleted.

12 changes: 8 additions & 4 deletions plugins/automation/plugin_nodes_help.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@

##### Floating IP reported by the Arc node

By default Arc nodes report the fixed IP and floating IP as a fact from the instance they run on. If the floating IP is not shown check the following:
Here's an improved English version:

* There is no floating IP assigned to the instance. If this is the case go the **servers area** and assign a floating IP to your instance.
* The Arc node is outdated. Check if the Arc node is still running and if it is running with the latest version. Check the documentation for more help.
* The Arc node is not running on an Openstack instance. In this case cannot be retrieved because the metadata service is not reachable from the instance.
By default, Arc nodes report both the fixed IP and floating IP as facts from the instance they are running on. If the floating IP is not displayed, consider the following possibilities:

1. No floating IP is assigned to the instance. In this case, navigate to the **Servers section** and allocate a floating IP to your instance.

2. The Arc node is outdated. Verify that the Arc node is still operational and running the latest version. Consult the documentation for further guidance.

3. The Arc node is not operating on an OpenStack instance. In this scenario, the floating IP cannot be retrieved because the metadata service is inaccessible from the instance.
1 change: 1 addition & 0 deletions plugins/block_storage/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This project rocks and uses MIT-LICENSE.
3 changes: 0 additions & 3 deletions plugins/block_storage/README.rdoc

This file was deleted.

1 change: 1 addition & 0 deletions plugins/compute/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This project rocks and uses MIT-LICENSE.
3 changes: 0 additions & 3 deletions plugins/compute/README.rdoc

This file was deleted.

15 changes: 10 additions & 5 deletions plugins/compute/plugin_instances_help.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,14 @@

##### Creating new servers

By default new servers you create are not accessible from outside the network they were deployed into. To create a VM with external access follow these steps:
Here's an improved English version:

1. Create a new VM instance: since you'll most likely eventually want to login via SSH, be sure to also **create or import an SSH public key** (if you haven't done so already) and specify the key during VM creation. You won't be able to add your key later to an already existing VM.
2. Once the instance is created and an IP has been assigned from the private network, associate a Floating IP to the instance. Before doing this you will need to allocate one to your project from the External network pool.
3. The instance is now accessible via the Floating IP you assigned. However, during creation (unless you specified otherwise) it was assigned to your project's Default security group. Before you can access via SSH or ping the instance you need ensure the security group has a rule allowing ingress for TCP port 22 and/or ICMP Type 8 Code 0 respectively. Corresponding egress rules are also required.
4. You should now be able to access the instance via SSH using ssh [user]@[floating ip]. In most cases the user is `ccloud` (for CoreOS `core`). On older images before March 2017 the user is dependent on the image operating system: for Ubuntu use 'ubuntu', for Cirros use 'cirros', for RHEL use 'fedora' and for SLES use 'root'. You also need to make sure that your SSH client is using the private key corresponding to the public key you have assigned during machine creation.
By default, newly created servers are not accessible from outside their deployment network. To create a VM with external access, follow these steps:

1. Create a new VM instance: As you'll likely want to log in via SSH eventually, ensure you create or import an SSH public key (if you haven't already) and specify it during VM creation. Note that you cannot add a key to an existing VM later.

2. Once the instance is created and assigned an IP from the private network, associate a Floating IP with the instance. Before doing this, you'll need to allocate one to your project from the External network pool.

3. The instance is now accessible via the assigned Floating IP. However, during creation (unless specified otherwise), it was assigned to your project's Default security group. Before you can access the instance via SSH or ping it, ensure the security group has rules allowing ingress for TCP port 22 and/or ICMP Type 8 Code 0, respectively. Corresponding egress rules are also required.

4. You should now be able to access the instance via SSH using the command: ssh [user]@[floating ip]. In most cases, the user is 'ccloud' (for CoreOS, use 'core'). On older images (before March 2017), the user depends on the image operating system: for Ubuntu use 'ubuntu', for Cirros use 'cirros', for RHEL use 'fedora', and for SLES use 'root'. Ensure your SSH client is using the private key corresponding to the public key you assigned during machine creation.
1 change: 1 addition & 0 deletions plugins/dns_service/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This project rocks and uses MIT-LICENSE.
3 changes: 0 additions & 3 deletions plugins/dns_service/README.rdoc

This file was deleted.

4 changes: 0 additions & 4 deletions plugins/email_service/plugin_help.md
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
#### Email Service

##### What it is

##### How to use
1 change: 1 addition & 0 deletions plugins/identity/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This project rocks and uses MIT-LICENSE.
3 changes: 0 additions & 3 deletions plugins/identity/README.rdoc

This file was deleted.

20 changes: 20 additions & 0 deletions plugins/image/MIT-LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright 2015 TODO: Write your name

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1 change: 1 addition & 0 deletions plugins/image/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This project rocks and uses MIT-LICENSE.
3 changes: 0 additions & 3 deletions plugins/image/README.rdoc

This file was deleted.

4 changes: 2 additions & 2 deletions plugins/image/plugin_os_images_private_help.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

##### Creating new private images

You can bring your own images to deploy instances. We store the data in Swift.
You have the option to use your own custom images for deploying instances. We store these images in our Swift object storage system.

Therefore you have to **make sure you have object storage enabled** for this project.
To utilize this feature, please ensure that object storage is activated for your project. This is a prerequisite for storing and accessing your custom images.
1 change: 1 addition & 0 deletions plugins/inquiry/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This project rocks and uses MIT-LICENSE.
3 changes: 0 additions & 3 deletions plugins/inquiry/README.rdoc

This file was deleted.

20 changes: 20 additions & 0 deletions plugins/key_manager/MIT-LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright 2022 TODO: Write your name

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1 change: 1 addition & 0 deletions plugins/key_manager/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This project rocks and uses MIT-LICENSE.
3 changes: 0 additions & 3 deletions plugins/key_manager/README.rdoc

This file was deleted.

1 change: 1 addition & 0 deletions plugins/kubernetes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This project rocks and uses MIT-LICENSE.
3 changes: 0 additions & 3 deletions plugins/kubernetes/README.rdoc

This file was deleted.

1 change: 1 addition & 0 deletions plugins/lookup/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This project rocks and uses MIT-LICENSE.
3 changes: 0 additions & 3 deletions plugins/lookup/README.rdoc

This file was deleted.

1 change: 1 addition & 0 deletions plugins/masterdata_cockpit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This project rocks and uses MIT-LICENSE.
20 changes: 20 additions & 0 deletions plugins/networking/MIT-LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright 2022 TODO: Write your name

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1 change: 1 addition & 0 deletions plugins/networking/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This project rocks and uses MIT-LICENSE.
3 changes: 0 additions & 3 deletions plugins/networking/README.rdoc

This file was deleted.

1 change: 1 addition & 0 deletions plugins/shared_filesystem_storage/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This project rocks and uses MIT-LICENSE.
3 changes: 0 additions & 3 deletions plugins/shared_filesystem_storage/README.rdoc

This file was deleted.

1 change: 1 addition & 0 deletions plugins/tools/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This project rocks and uses MIT-LICENSE.
4 changes: 0 additions & 4 deletions plugins/tools/README.rdoc

This file was deleted.

1 change: 1 addition & 0 deletions plugins/webconsole/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This project rocks and uses MIT-LICENSE.
3 changes: 0 additions & 3 deletions plugins/webconsole/README.rdoc

This file was deleted.

0 comments on commit 6ee0164

Please sign in to comment.