Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove references to cloudreach #1098

Closed
zaro0508 opened this issue Sep 18, 2021 · 13 comments · Fixed by Sceptre/sceptre.github.io#9
Closed

remove references to cloudreach #1098

zaro0508 opened this issue Sep 18, 2021 · 13 comments · Fixed by Sceptre/sceptre.github.io#9

Comments

@zaro0508
Copy link
Contributor

zaro0508 commented Sep 18, 2021

Cloudreach wants to extricate sceptre from cloudreach and make it a purely open source supported project. According to @rdkr That process involves doing the following things..

  1. need to change the logo (on the github org and anywhere else) as it is a trademark and otherwise would have to do some trademark license or something so i just said we can change it... any good at designing logos? 🎨
    and some technical bits:
  2. docs website should probably change to the github.io address instead of the https://sceptre.cloudreach.com/ one, and remove the copyright in the docs
  3. i've created a gmail account to use for stuff in the immediate term. i've added it as the primary email for pypi and pypi-test, and also registered a dockerhub account called sceptreorg to the same email.
  4. things still release to the cloudreach dockerhub - i'd imagine that'll just keep working to be honest, but i registered the above email account in case its preferable to switch to using it as an org separate to have full control
  5. i think circleci is all just auth through github so nothing to do there? not sure though

In addition I also think that doc references to cloudreach.com should be changed to point to sceptre project resources on github.

@ngfgrant
Copy link
Contributor

@zaro0508 who in cloudreach authorized this?

@ngfgrant
Copy link
Contributor

I’ve asked for written legal approval from cloudreach so that we can do this. It’s the right thing to do - we just need to make sure we do it the right way!

@sftrabbit
Copy link
Contributor

Hey folks, can we pull together a list of copyright notices that mention Cloudreach as the copyright owner? I can at least see LICENSE, NOTICE, and docs/_source/conf.py. What about in other repositories under this org?

@zaro0508 zaro0508 changed the title remove references to cloudreach from docs remove references to cloudreach Sep 20, 2021
zaro0508 added a commit to zaro0508/sceptre that referenced this issue Sep 21, 2021
This is to partially resolve issue Sceptre#1098.

We plan to move sceptre docs away from hosting on a cloudreach
domain to https://readthedocs.org/project/sceptre

This PR builds the sphinx docs on readthedocs.org
@rdkr
Copy link

rdkr commented Oct 24, 2021

@zaro0508 who in cloudreach authorized this?

chris williams and legal, upon my request. i can forward the emails if you would like - just drop me an email

I’ve asked for written legal approval from cloudreach so that we can do this. It’s the right thing to do - we just need to make sure we do it the right way!

as mentioned by @zaro0508, the steps above are what are required to do it the right way

@jfalkenstein
Copy link
Contributor

@zaro0508 What's the status on this? Is this going to make it into the coming release, you think?

@zaro0508
Copy link
Contributor Author

zaro0508 commented Nov 2, 2021

the status is that this is an ongoing process @jfalkenstein. Most likely nothing is going to change for the next release.

@sftrabbit
Copy link
Contributor

sftrabbit commented Nov 2, 2021

Hey folks,

Firstly, regarding copyright: I've spoken to the legal team in Cloudreach about what approach they'd like to take regarding the copyright license. The best thing to do is treat this Sceptre repository as a redistribution of the original Sceptre, under a new license. Taking a look at the Apache 2.0 license:

  1. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
  • You must give any other recipients of the Work or Derivative Works a copy of this License; and
  • You must cause any modified files to carry prominent notices stating that You changed the files; and
  • You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
  • If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

What I would suggest is that a new open source license is prepended to the existing LICENSE file. Perfectly fine to stick with an Apache 2.0 license, you'll just need to name a new copyright owner. Below that license, write something like "This is a redistribution of the original Sceptre project licensed under the following:" followed by the existing Cloudreach license. So something like this:

Apache Software License 2.0

Copyright 2021 <new copyright owner>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

------------------------

This is a redistribution of the original Sceptre project licensed under the following:

Apache Software License 2.0

Copyright 2017 Cloudreach Europe Limited or its affiliates. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

You will also need to do this to the NOTICE file. For copyright notices that appear elsewhere (like in documentation), feel free to do what you like with them (remove them or change them to mention the new copyright owner). Once this is done, you have effectively created a fork of Sceptre under your own license.

Cloudreach is happy for you to continue using the Sceptre name - I don't believe that it is actually trademarked by Cloudreach.

Now for the other points in this issue:

need to change the logo (on the github org and anywhere else) as it is a trademark and otherwise would have to do some trademark license or something so i just said we can change it... any good at designing logos? 🎨

Yes, a new logo should be created. However, I noticed that your proposed new logo (posted in og-aws Slack) was still using the Cloudreach branding (the isobar pattern in the background), so please make sure to make the new logo from scratch. For now, you could just remove the logo (I'm not sure where it currently appears).

docs website should probably change to the github.io address instead of the https://sceptre.cloudreach.com/ one, and remove the copyright in the docs

Honestly, I think it's probably best if you just make this switch and then tell us when it's done. Then I can get our IT team to forward the old domain to yours.

i've created a gmail account to use for stuff in the immediate term. i've added it as the primary email for pypi and pypi-test, and also registered a dockerhub account called sceptreorg to the same email.

👍

things still release to the cloudreach dockerhub - i'd imagine that'll just keep working to be honest, but i registered the above email account in case its preferable to switch to using it as an org separate to have full control

Yes, please move to a new DockerHub account. Which DockerHub user is it currently authenticating as? We will need to revoke this access on our end. Please let us know when progress is made on this.

@zaro0508
Copy link
Contributor Author

@sftrabbit A new icon has been created and uploaded to this github org.

The doc update PR Sceptre/sceptre.github.io#9 has been merged and https://docs.sceptre-project.org/ is now live. Could you please have Cloudreach redirect https://sceptre.cloudreach.com to the new docs site?

@sftrabbit
Copy link
Contributor

@zaro0508 Turns out the people who have the necessary permissions are on holiday, but I should be able to sort this out tomorrow. I'll keep you posted.

@sftrabbit
Copy link
Contributor

I think the only things left to resolve here are the license notices and the DockerHub credentials. What's the status of these?

@zaro0508
Copy link
Contributor Author

zaro0508 commented Dec 5, 2021

@sftrabbit Are you suggesting that we should update the license notices in Sceptre/sceptre repo only or in all repos in the Sceptre org?

@zaro0508
Copy link
Contributor Author

docker containers have been moved to https://hub.docker.com/u/sceptreorg with PR #1265 and PR Sceptre/sceptre-circleci#16

@zaro0508
Copy link
Contributor Author

Unless there's anything else @sftrabbit I'm going to say that we are done with this issue.

jfalkenstein added a commit that referenced this issue Feb 11, 2023
## 4.0.0 (2023.02.08)

### Added
 - [Resolve #1283] Introducing `sceptre_role`, `cloudformation_service_role` (#1295)
   - These are just iam_role and role_arn renamed to be a lot clearer. See "Deprecations" below.


### Changed
 - [Resolve #1299] Making the ConnectionManager a more "friendly" interface for hooks, resolvers,
   and template handlers (#1287, #1300)
   - This creates adds the public `get_session()` and
     `create_session_environment_variables()` methods to make AWS interactions
     easier and more consistent with individual stack configurations for
     iam_role, profile, and region configurations.
   - The `call()` method now properly distinguishes between default stack
     configurations for profile, region, and `sceptre_role` and setting those to
     `None` to nullify them.
 - Preventing Duplicate Deprecation Warnings from being emitted (#1297)

#### _Potentially_ Breaking Changes
 - The !cmd hook now invokes the passed command using the AWS environment
   variables that correspond with the stack's IAM configurations (i.e. iam_role,
   profile, region). This means that the hook will operate the same as every
   other part of Sceptre and regard how the stack is configured. This should make
   it easier to invoke other tools like AWS CLI with your hooks. However, if
   your project is setting environment variables with the intent to change how
   the command authenticates with AWS (such as a different token, profile, or
   region), these environment variables will be overridden. To maintain the same
   functionality, you should prefix your command with
   `export AWS_SESSION_TOKEN={{environment_variable.AWS_SESSION_TOKEN}} &&` (or
   whatever other environment variable(s) you need to explicitly set).

### Deprecations
 - [Resolve #1283] Deprecating `iam_role`, `role_arn`, and `template_path` (#1295)
   - `iam_role` and `role_arn` have been aliased to `sceptre_role` and
      `cloudformation_service_role`. Using these fields will result in a
      DeprecationWarning.
   - `template_path` has actually been slated for removal since v2.7. `template`
      should be used instead. Using `template_path` will result in a
      DeprecationWarning.
   - All three deprecated StackConfig fields will be removed in v5.0.0.

## 3.3.0 (2023.02.06)

### Added
 - [Resolve #1261] Add coloured differ (#1260)
   - Implements coloured diffs for the diff (difflib) command. Responds to --no-color.
 - [Resolves #1271] Extend stack colourer to include "IMPORT" states (#1272)
 - [Resolves #1179] cloudformation disable-rollback option (#1282)
   - Allow user to disable a cloudformation rollback on a sceptre deployment.

### Changed
 - [Resolve #1098] Deploy docker container to sceptreorg repo (#1265)
   - Deploy sceptre docker images to dockerhub sceptreorg repo instead of cloudreach repo
 - Updating Setuptools and wheel versions to avert security issues
 - [Resolve #1293] Improve the Stack Config Jinja Syntax Error Message to include the Stack Name (#1294)
 - [Resolves #1267] Improve the Stack Config Jinja Error Message to include the Stack Name (#1269)

### Fixed
 - [Resolve #1273] Events start from response time (#1275)
   - Resolves #1273 by starting event filtering from the timestamp returned in
     the AWS response headers rather than relying on the workstation clock.
 - [Resolve #1253] Failed downloads raise error (#1277)
   - Throwing an informative error when the template fails to download instead
     of passing the error message to CloudFormation.
 - [Resolves #1179] Changed disable-rollback default to None (#1288)
   - We want the default value to be None to represent "Do whatever's configured
     in the StackConfig" and True/False will override the StackConfig.

### Nonfunctional
 - Add tweet-release to CircleCI config (#1259)
 - [Resolves #1276] Adopt Black Auto-formatter (#1278)
   - Reformatting all Python files using the Black code formatter. This also
     delivers a new function for generating `__repr__` methods which was needed
     to deal with a line-too-long issue in Template. Per discussion in #1276 this
     PR also disables E203 in flake8.
 - Update sceptre-circleci docker image (#1284)
   - Update to build and test with a docker image that's based on the official
     circleci python docker image.
 - [Resolve #1264] Updating the CDK docs to point to the new sceptre-cdk-handler
   (#1285)
   - This updates our docs to no longer reference the old CDK approach (which
     didn't work with CDK assets). In its place, it references the new
     sceptre-cdk-handler package that covers that functionality.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants