feat: add IBM Softlayer to enable using IBM Classic Infrastructure #371

a-dubs · 2024-05-07T19:47:58Z

IBM Classic Infrastructure actually has quite a robust SDK. Adding IBM CLassic/Softlayer to pycloudlib will provide immediate value to Canonical, and I'm sure this could be useful for other 3rd parties.

aciba90

Thanks, @a-dubs, for adding this feature!

I have left in-line comments / requests. In addition to that, could we please add a documentation section to docs/clouds, explaining at least what configuration is required to use the new cloud (api keys, etc)?

pycloudlib/ibm_softlayer/cloud.py

pycloudlib/ibm_softlayer/instance.py

pycloudlib/ibm_softlayer/cloud.py

pycloudlib/instance.py

pycloudlib/ibm_softlayer/cloud.py

aciba90

Thanks, @a-dubs, for addressing the concerns and fixing stuff.

Apart from in-line comments, what is still missing is:

could we please add a documentation section to docs/clouds, explaining at least what configuration is required to use the new cloud (api keys, etc)?

Documentation about IBM classic's specificities.

Another question: we refer to IBM classic / softlayer interchangeably, with the code and within log messages and exceptions. I wonder if it would be better to stick to one of the terms globally, or if not, clearly document it somewhere.

pycloudlib/ibm_softlayer/cloud.py

pycloudlib/ibm_softlayer/instance.py

VERSION

a-dubs · 2024-06-05T18:32:17Z

Another question: we refer to IBM classic / softlayer interchangeably, with the code and within log messages and exceptions. I wonder if it would be better to stick to one of the terms globally, or if not, clearly document it somewhere.

Good question. Unfortunately, at this point, I really think I'd rather refer to it as IBM Classic. This is mostly because despite the IBM provided sdk and api being called softlayer, this is not obvious to an end user, who sees either "IBM VPC" or "IBM Classic" when browsing IBM Cloud Console, with no obvious mention of softlayer. So if you agree, I'll go through and mass rename everything to IBM Classic. I would like the naming to be consistent throughout for sure.

Also, when I write up the docs for this new IBM ~~Softlayer~~ Classic cloud, I'll be sure to have a small preamble in there that explains this naming confusion.

aciba90 · 2024-06-06T08:50:28Z

+1 to the renaming to classic, thanks!

aciba90

Many thanks, @a-dubs, for the renaming and documentation efforts, this is getting in shape.

I left in-line comments and in addition to that we need to:

Include the new cloud config in pycloudlib.toml.template.
Remove Softlayer from TODO.md.

pycloudlib/__init__.py

examples/ibm_classic.py

pycloudlib/ibm_classic/__init__.py

pycloudlib/ibm_classic/cloud.py

docs/clouds/ibm-classic.md

a-dubs · 2024-06-20T21:10:50Z

leaving a TODO for myself:
add more config options to pycloudlib.toml such as domain_name since this should not change between instance launches

aciba90

Thanks for addressing the comments. I left some minor comments.

leaving a TODO for myself:
add more config options to pycloudlib.toml such as domain_name since this should not change between instance launches

Is this a TODO for this PR or for the future? If for the future, could you please create a GH issue to not forget about it, or let others help with it?

tests/unit_tests/ibm_softlayer/test_cloud.py

pycloudlib.toml.template

pycloudlib/ibm_classic/cloud.py

a-dubs · 2024-06-25T12:24:02Z

@aciba90 regarding the delete_image function, mypy only throws an error when I change the function definition to have image_id be an int. Also if self._image_manager.delete_image(int(image_id)) raises an error on failing to cast an int, then that is good, because the softlayer image id is numeric and should never fail to be cast to an int. Should I wrap this in a try catch and raise a pycloudlib IBMClassicException though?

tests/unit_tests/ibm_classic/test_cloud.py

aciba90 · 2024-06-25T13:02:35Z

@aciba90 regarding the delete_image function, mypy only throws an error when I change the function definition to have image_id be an int. Also if self._image_manager.delete_image(int(image_id)) raises an error on failing to cast an int, then that is good, because the softlayer image id is numeric and should never fail to be cast to an int. Should I wrap this in a try catch and raise a pycloudlib IBMClassicException though?

Ahh, I see your point now, then I guess it does not matter that much. We could:

self._image_manager.delete_image(int(image_id)) (as-is) with or without exception handling
Use https://docs.python.org/3/library/typing.html#typing.cast and self._image_manager.delete_image(image_id)
self._image_manager.delete_image(image_id)
Modify the parent and children types associated to image_id to Union[str, int]

(1) does a superfluous type conversion at runtime
(2) is type-checking the softlayer API / SDK
(3) is probably obscure
(4) unnecessarily complex

I leave it up to you to decide.

a-dubs · 2024-06-25T13:04:16Z

I'll go for (1) I guess then! Feels like the better solution among the rest. Thanks for your input!

a-dubs · 2024-06-25T13:08:14Z

I'm doing one final round of testing to make sure everything functions as desired. I will report back when done.

aciba90

LGTM, thanks for the long work here!

a-dubs · 2024-06-26T14:51:19Z

IT FINALLY WORKED RAHHHH LETS GOOOO

                                 #@@@@@@@@@@@@@@@#                                                  
                           *@@@*.........::::::::::-%@@@*                                           
                        %@@:..........:**=:::::::::::::::=@@%                                       
                     @@+.....-@@@#:....::::::*@%::=@:::::::::+@@                                    
                  #@-....@%:..........:::::::::::-@=:#-:::::::::%@@                                 
              +@@@%...*@..............::::-+%%#=:::::#:#:-:::::::::@@#                              
           #@#.....%@@...........+@@@@@@@@#:::::::::-::::%@::::::::::-@#                            
    #@@@@%@@@*..#..%:.......:@@@@@@@*:::::::::::::-@:::::::@:::::::::::-@+                          
  #@......%.....:.@......*@@@@@@#.::::::::::::::@@%@::#@#:::::-*+-:::::-:-:-                        
  @@@:........:%.-.........@@@@...:-%@@@@@@@@@@@+*@@@-:@:-@::..+*=...++--+.#%                       
  @.@*:......*#..........:@@@@@@@#:::::::::::::::-:::-@:*::::.:::::::-%+-#---@                      
  @..@:......@*.........@@@@*...::::-:::::::+%#=---:=-:@:::+.+::::::::::------@                     
  @...@......++....%%@@@@@:....:::::::::::::::::--:::::#:::=.::::::::::--------@#                   
  @=..-@.....:@......*@@@@@@@@@@@@@@@@@*#@::::::*#:::-*::::.=:::%::::::---------@*                  
  @.@%:.#@....@@@@@@*:.......:::::::::::+@@@-::::-+=%@%::::.+::::-::::-----------@#                 
  @.......*@@@-....+@@@@@@%##########%%@@@#@@@:::::@@@:::::.+::::-+::-------------@                 
 @.....@@#..:%@@@##########################%@#@%::::@@:::::::::::::#---------------@                
#-...@..:@@%#######@..@@###@. .@%##@..@##@: .@%#@::::@:::::+.::-:::-----------------@               
@..#-.@@#@@@######@.  ..@%=    .%@@.  .%@.   .@#@@::::@::::= =-:::------------------@               
@.:+%@#%@. ..@%#%@.     .+.     .=.    :.     @. .@::::*::::.*:::----#--*-----------=@              
 @%@###@.    ..#*.       %.     ..     #.    ..   .@-:::::::*.-:------=--@-----------@              
  @@.#@=                 %.     .            ..  .*.@-::-@::-.*:------%---@----------@%             
   @. .:                 ..    .#     :.   ..   .%. :@-::=@-:=.--------@--+@---------%@             
   @. .@                 =.    :.    .=  .::  .:...%@@@-::*@--.*-------*---@=--------+@             
    @. ..             ...--. .*%@@#@@@@@@@@@@@@@@@@@@@@@-::#@**.--------@---@---------@             
    *#.        .+@@@%#@@:..%+.  .@%%@@@@@@@%@@@@@@@@@@@@@:::@=*-.-------%---@---------@             
      @.  .@#-...+.   .+   =.  .@@@@@@@@@@@@@@@@@@@@@@@@@@---@-=.=------=@---%----**+-@             
       %@.@.     .   .:. .:=..:@@@%%%%%%%%%@@@@@@@@@@%%%@@@---@-=.#------@---%--#.#=#. +            
          @@#...#=..=@@%%%%%%%@@@@@@@@@@@@@@@@@@@%%%%%%%%@@@---@-%.+-----@+---==.*---=@             
           @@@@@@@@@@@@@@@@@@@@@@@@@%%%@@%%%%%@%%%%%%%%%%%@@@---@@*.=----+@---=:.----+@             
            @-.=@%#%@@@@@@%%%%%%%@@@@@%##%%%@%%%%%%%%%%%%%@@@@---@@#.*----@----.*----@@             
             @.:#@%#%%%@%@@@@@@@@%%@%#####%@%%%%%%%%%%%%%@@@@@@--=@--..---@=--=.-----@              
             #@::@%@%%%%@@%%%%@@@@@#######@%%%%%%%%%%%%@@@@@@@@@--=---*..=%%-*.+----#@              
              @=::@#@%%%%%@@@@%%@@#######%##%%%%%%%%%%@@@@@@@@@@@-------=.....=--#--@               
               @:::@#%#%%%%@@@@@%#######%####%%%%%%%@@@@@%@@@@@@@@--#------@-----@-@                
               *@::-%%#%%%%@@@@##############%%%%%@@@=.    .#@@@@@---=-----@-----@@*                
                @=::#%@#%%%@@@###############%%%@%.--.       .%@@@+--------@----@@%                 
                 @:::%@@@@@.=@###########%@@#@..       .      .-@@---*-----@----@@                  
                @@+:@@%*.. .@##%%..+@@*.                #-... .=@----@-----@---@@                   
                @+@@    ..:                   .*.        @####%#----@------@--@%                    
               %-%@.                   .       #@@@=.  .:@##@#----@#@-----#@@@                      
               @*@                     #       :%####%@@%@@----@@*+@-----=@@#                       
              @#*.                     .+.    .@#####@@#-%=*%#*+@=#-----%@%                         
             #@*@. .+%.         .@+.   .@%@%:.@#%@@%+==+@%==++@-------+@%                           
             @:@@..@%@%  .@@.  .%%##@#*@###@@@*-%=++==+%+@@#==+%--%@@@*                             
             @::@@%###@%-@###@:%%####@@@@+---=-----+===============+*%                              
             #@:::@@%######%@@@@@@*-:-:::--+#*=-=-+%=%+===+*%#====++++*%%%%                         
               @@:::::::-:::::::+%@@@-::------------------%#+%#  #%#++++%+                          
                  *@@@@@@@@@@@@@@*@=@+@=**----------%@@@@*             ##+++%*                      
                                #%@@@@@@@@@@@@@@%#*                        +%*++%#                  
                                                                                 #%#%               
                                                                                                    
                                                                                          %%%       
                                                                                             %+*%   
                                                                                                #%*#

a-dubs · 2024-06-26T14:52:07Z

Proof of working run (in case i gaslight myself and forget if it worked or not):
ibm-classic-example-successful-run.log

aciba90 · 2024-06-26T14:55:52Z

Sweet @a-dubs, could you please resolve conflicts in VERSION?

aciba90 · 2024-06-26T15:05:50Z

Latest commit: 50089ec contains commented code and non-trivial changes. Is that all required?

Adding the other infrastructure on IBM Cloud, IBM Classic, will allow pycloudlib to have full lifecycle management for IBM Cloud.

Co-authored-by: Alberto Contreras <aciba90@gmail.com>

a-dubs · 2024-06-26T15:09:10Z

@aciba90 fixed version

a-dubs force-pushed the add-ibm-softlayer branch from 8db9b23 to 11de863 Compare May 7, 2024 19:48

a-dubs marked this pull request as draft May 7, 2024 20:07

a-dubs force-pushed the add-ibm-softlayer branch 6 times, most recently from f850131 to 56ba606 Compare May 14, 2024 14:47

a-dubs marked this pull request as ready for review May 14, 2024 14:47

a-dubs force-pushed the add-ibm-softlayer branch 2 times, most recently from 391ce62 to 981da5c Compare May 23, 2024 02:54

aciba90 self-assigned this May 23, 2024

aciba90 requested changes May 27, 2024

View reviewed changes

a-dubs force-pushed the add-ibm-softlayer branch 6 times, most recently from e3a0ff3 to 208438f Compare June 4, 2024 15:41

aciba90 reviewed Jun 5, 2024

View reviewed changes

pycloudlib/instance.py Show resolved Hide resolved

pycloudlib/ibm_softlayer/cloud.py Outdated Show resolved Hide resolved

pycloudlib/ibm_softlayer/cloud.py Outdated Show resolved Hide resolved

aciba90 requested changes Jun 5, 2024

View reviewed changes

pycloudlib/ibm_softlayer/cloud.py Outdated Show resolved Hide resolved

pycloudlib/ibm_softlayer/instance.py Outdated Show resolved Hide resolved

VERSION Outdated Show resolved Hide resolved

a-dubs force-pushed the add-ibm-softlayer branch 2 times, most recently from ff1dc9e to bcded64 Compare June 17, 2024 20:08

aciba90 requested changes Jun 18, 2024

View reviewed changes

aciba90 requested changes Jun 25, 2024

View reviewed changes

tests/unit_tests/ibm_softlayer/test_cloud.py Outdated Show resolved Hide resolved

pycloudlib.toml.template Outdated Show resolved Hide resolved

pycloudlib.toml.template Outdated Show resolved Hide resolved

pycloudlib/ibm_classic/cloud.py Outdated Show resolved Hide resolved

a-dubs force-pushed the add-ibm-softlayer branch from b7b169e to d6e33de Compare June 25, 2024 12:30

aciba90 reviewed Jun 25, 2024

View reviewed changes

tests/unit_tests/ibm_classic/test_cloud.py Outdated Show resolved Hide resolved

aciba90 approved these changes Jun 25, 2024

View reviewed changes

a-dubs and others added 12 commits June 26, 2024 11:08

feat: allow for specifying custom timeout in _wait_for_execute()

a907448

feat: add IBM Softlayer to enable using IBM Classic Infrastructure

307e1af

Adding the other infrastructure on IBM Cloud, IBM Classic, will allow pycloudlib to have full lifecycle management for IBM Cloud.

docs(ibm-classic): add docs for ibm-classic

e8bfdb4

refactor(ibm_clasic): renamed IBM Softlayer to IBM Classic

0a41554

add ibmclassic to pycloudlib.toml.template

cd7ce3c

monster commit for hopefully final round of PR changes

e84b1ea

Update pycloudlib.toml.template

b2e6bc0

Co-authored-by: Alberto Contreras <aciba90@gmail.com>

Update pycloudlib.toml.template

214486f

Co-authored-by: Alberto Contreras <aciba90@gmail.com>

rename unit tests

a9e07d4

update docs to have domain_name info

40f38e2

adding init py for ibm classic unit tests

63da15f

final changes!!!

534fe2f

a-dubs force-pushed the add-ibm-softlayer branch from 50089ec to df5e4f2 Compare June 26, 2024 15:08

bump version

5a13a2c

a-dubs force-pushed the add-ibm-softlayer branch from df5e4f2 to 5a13a2c Compare June 26, 2024 15:13

final tweaks from review with alberto

ab9c09b

a-dubs force-pushed the add-ibm-softlayer branch from f7b6a89 to ab9c09b Compare June 26, 2024 17:06

aciba90 merged commit 86c02b8 into canonical:main Jun 27, 2024
4 checks passed

feat: add IBM Softlayer to enable using IBM Classic Infrastructure #371

feat: add IBM Softlayer to enable using IBM Classic Infrastructure #371

Uh oh!

Conversation

a-dubs commented May 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aciba90 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aciba90 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

a-dubs commented Jun 5, 2024

Uh oh!

aciba90 commented Jun 6, 2024

Uh oh!

aciba90 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

a-dubs commented Jun 20, 2024

Uh oh!

aciba90 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

a-dubs commented Jun 25, 2024

Uh oh!

Uh oh!

aciba90 commented Jun 25, 2024

Uh oh!

a-dubs commented Jun 25, 2024

Uh oh!

a-dubs commented Jun 25, 2024

Uh oh!

aciba90 left a comment

Choose a reason for hiding this comment

Uh oh!

a-dubs commented Jun 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

a-dubs commented Jun 26, 2024

Uh oh!

aciba90 commented Jun 26, 2024

Uh oh!

aciba90 commented Jun 26, 2024

Uh oh!

a-dubs commented Jun 26, 2024

Uh oh!

Uh oh!

Uh oh!

a-dubs commented May 7, 2024 •

edited

Loading

a-dubs commented Jun 26, 2024 •

edited

Loading